Class OperationMetadata

  • All Implemented Interfaces:
    OperationMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class OperationMetadata
    extends com.google.protobuf.GeneratedMessageV3
    implements OperationMetadataOrBuilder
     Represents the metadata of the long-running operation.
     
    Protobuf type google.cloud.functions.v2beta.OperationMetadata
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasCreateTime

        public boolean hasCreateTime()
         The time the operation was created.
         
        .google.protobuf.Timestamp create_time = 1;
        Specified by:
        hasCreateTime in interface OperationMetadataOrBuilder
        Returns:
        Whether the createTime field is set.
      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The time the operation was created.
         
        .google.protobuf.Timestamp create_time = 1;
        Specified by:
        getCreateTime in interface OperationMetadataOrBuilder
        Returns:
        The createTime.
      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time the operation was created.
         
        .google.protobuf.Timestamp create_time = 1;
        Specified by:
        getCreateTimeOrBuilder in interface OperationMetadataOrBuilder
      • hasEndTime

        public boolean hasEndTime()
         The time the operation finished running.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        hasEndTime in interface OperationMetadataOrBuilder
        Returns:
        Whether the endTime field is set.
      • getEndTime

        public com.google.protobuf.Timestamp getEndTime()
         The time the operation finished running.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        getEndTime in interface OperationMetadataOrBuilder
        Returns:
        The endTime.
      • getEndTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
         The time the operation finished running.
         
        .google.protobuf.Timestamp end_time = 2;
        Specified by:
        getEndTimeOrBuilder in interface OperationMetadataOrBuilder
      • getTarget

        public String getTarget()
         Server-defined resource path for the target of the operation.
         
        string target = 3;
        Specified by:
        getTarget in interface OperationMetadataOrBuilder
        Returns:
        The target.
      • getTargetBytes

        public com.google.protobuf.ByteString getTargetBytes()
         Server-defined resource path for the target of the operation.
         
        string target = 3;
        Specified by:
        getTargetBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for target.
      • getVerbBytes

        public com.google.protobuf.ByteString getVerbBytes()
         Name of the verb executed by the operation.
         
        string verb = 4;
        Specified by:
        getVerbBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for verb.
      • getStatusDetailBytes

        public com.google.protobuf.ByteString getStatusDetailBytes()
         Human-readable status of the operation, if any.
         
        string status_detail = 5;
        Specified by:
        getStatusDetailBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for statusDetail.
      • getCancelRequested

        public boolean getCancelRequested()
         Identifies whether the user has requested cancellation
         of the operation. Operations that have successfully been cancelled
         have [Operation.error][] value with a
         [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
         `Code.CANCELLED`.
         
        bool cancel_requested = 6;
        Specified by:
        getCancelRequested in interface OperationMetadataOrBuilder
        Returns:
        The cancelRequested.
      • getApiVersionBytes

        public com.google.protobuf.ByteString getApiVersionBytes()
         API version used to start the operation.
         
        string api_version = 7;
        Specified by:
        getApiVersionBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for apiVersion.
      • hasRequestResource

        public boolean hasRequestResource()
         The original request that started the operation.
         
        .google.protobuf.Any request_resource = 8;
        Specified by:
        hasRequestResource in interface OperationMetadataOrBuilder
        Returns:
        Whether the requestResource field is set.
      • getRequestResource

        public com.google.protobuf.Any getRequestResource()
         The original request that started the operation.
         
        .google.protobuf.Any request_resource = 8;
        Specified by:
        getRequestResource in interface OperationMetadataOrBuilder
        Returns:
        The requestResource.
      • getRequestResourceOrBuilder

        public com.google.protobuf.AnyOrBuilder getRequestResourceOrBuilder()
         The original request that started the operation.
         
        .google.protobuf.Any request_resource = 8;
        Specified by:
        getRequestResourceOrBuilder in interface OperationMetadataOrBuilder
      • getStagesCount

        public int getStagesCount()
         Mechanism for reporting in-progress stages
         
        repeated .google.cloud.functions.v2beta.Stage stages = 9;
        Specified by:
        getStagesCount in interface OperationMetadataOrBuilder
      • getStages

        public Stage getStages​(int index)
         Mechanism for reporting in-progress stages
         
        repeated .google.cloud.functions.v2beta.Stage stages = 9;
        Specified by:
        getStages in interface OperationMetadataOrBuilder
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static OperationMetadata parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static OperationMetadata parseFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException
        Throws:
        IOException
      • newBuilderForType

        public OperationMetadata.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public OperationMetadata.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected OperationMetadata.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<OperationMetadata> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public OperationMetadata getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder