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 a long-running operation.
     
    Protobuf type google.cloud.speech.v2.OperationMetadata
    See Also:
    Serialized Form
    • Field Detail

      • CREATE_TIME_FIELD_NUMBER

        public static final int CREATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_TIME_FIELD_NUMBER

        public static final int UPDATE_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • KMS_KEY_NAME_FIELD_NUMBER

        public static final int KMS_KEY_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • KMS_KEY_VERSION_NAME_FIELD_NUMBER

        public static final int KMS_KEY_VERSION_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BATCH_RECOGNIZE_REQUEST_FIELD_NUMBER

        public static final int BATCH_RECOGNIZE_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CREATE_RECOGNIZER_REQUEST_FIELD_NUMBER

        public static final int CREATE_RECOGNIZER_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_RECOGNIZER_REQUEST_FIELD_NUMBER

        public static final int UPDATE_RECOGNIZER_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DELETE_RECOGNIZER_REQUEST_FIELD_NUMBER

        public static final int DELETE_RECOGNIZER_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UNDELETE_RECOGNIZER_REQUEST_FIELD_NUMBER

        public static final int UNDELETE_RECOGNIZER_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CREATE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER

        public static final int CREATE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER

        public static final int UPDATE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DELETE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER

        public static final int DELETE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UNDELETE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER

        public static final int UNDELETE_CUSTOM_CLASS_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CREATE_PHRASE_SET_REQUEST_FIELD_NUMBER

        public static final int CREATE_PHRASE_SET_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_PHRASE_SET_REQUEST_FIELD_NUMBER

        public static final int UPDATE_PHRASE_SET_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DELETE_PHRASE_SET_REQUEST_FIELD_NUMBER

        public static final int DELETE_PHRASE_SET_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UNDELETE_PHRASE_SET_REQUEST_FIELD_NUMBER

        public static final int UNDELETE_PHRASE_SET_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • UPDATE_CONFIG_REQUEST_FIELD_NUMBER

        public static final int UPDATE_CONFIG_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PROGRESS_PERCENT_FIELD_NUMBER

        public static final int PROGRESS_PERCENT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • BATCH_RECOGNIZE_METADATA_FIELD_NUMBER

        public static final int BATCH_RECOGNIZE_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values
    • 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
      • hasUpdateTime

        public boolean hasUpdateTime()
         The time the operation was last updated.
         
        .google.protobuf.Timestamp update_time = 2;
        Specified by:
        hasUpdateTime in interface OperationMetadataOrBuilder
        Returns:
        Whether the updateTime field is set.
      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         The time the operation was last updated.
         
        .google.protobuf.Timestamp update_time = 2;
        Specified by:
        getUpdateTime in interface OperationMetadataOrBuilder
        Returns:
        The updateTime.
      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         The time the operation was last updated.
         
        .google.protobuf.Timestamp update_time = 2;
        Specified by:
        getUpdateTimeOrBuilder in interface OperationMetadataOrBuilder
      • getResourceBytes

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

        public com.google.protobuf.ByteString getMethodBytes()
         The method that triggered the operation.
         
        string method = 4;
        Specified by:
        getMethodBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for method.
      • getKmsKeyName

        public String getKmsKeyName()
         The [KMS key
         name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
         the content of the Operation is encrypted. The expected format is
         `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
         
        string kms_key_name = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKmsKeyName in interface OperationMetadataOrBuilder
        Returns:
        The kmsKeyName.
      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         The [KMS key
         name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which
         the content of the Operation is encrypted. The expected format is
         `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
         
        string kms_key_name = 6 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKmsKeyNameBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for kmsKeyName.
      • getKmsKeyVersionName

        public String getKmsKeyVersionName()
         The [KMS key version
         name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
         with which content of the Operation is encrypted. The expected format is
         `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
         
        string kms_key_version_name = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKmsKeyVersionName in interface OperationMetadataOrBuilder
        Returns:
        The kmsKeyVersionName.
      • getKmsKeyVersionNameBytes

        public com.google.protobuf.ByteString getKmsKeyVersionNameBytes()
         The [KMS key version
         name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions)
         with which content of the Operation is encrypted. The expected format is
         `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.
         
        string kms_key_version_name = 7 [(.google.api.resource_reference) = { ... }
        Specified by:
        getKmsKeyVersionNameBytes in interface OperationMetadataOrBuilder
        Returns:
        The bytes for kmsKeyVersionName.
      • hasBatchRecognizeRequest

        public boolean hasBatchRecognizeRequest()
         The BatchRecognizeRequest that spawned the Operation.
         
        .google.cloud.speech.v2.BatchRecognizeRequest batch_recognize_request = 8;
        Specified by:
        hasBatchRecognizeRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the batchRecognizeRequest field is set.
      • hasCreateRecognizerRequest

        public boolean hasCreateRecognizerRequest()
         The CreateRecognizerRequest that spawned the Operation.
         
        .google.cloud.speech.v2.CreateRecognizerRequest create_recognizer_request = 9;
        Specified by:
        hasCreateRecognizerRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the createRecognizerRequest field is set.
      • hasUpdateRecognizerRequest

        public boolean hasUpdateRecognizerRequest()
         The UpdateRecognizerRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UpdateRecognizerRequest update_recognizer_request = 10;
        Specified by:
        hasUpdateRecognizerRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the updateRecognizerRequest field is set.
      • hasDeleteRecognizerRequest

        public boolean hasDeleteRecognizerRequest()
         The DeleteRecognizerRequest that spawned the Operation.
         
        .google.cloud.speech.v2.DeleteRecognizerRequest delete_recognizer_request = 11;
        Specified by:
        hasDeleteRecognizerRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the deleteRecognizerRequest field is set.
      • hasUndeleteRecognizerRequest

        public boolean hasUndeleteRecognizerRequest()
         The UndeleteRecognizerRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UndeleteRecognizerRequest undelete_recognizer_request = 12;
        Specified by:
        hasUndeleteRecognizerRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the undeleteRecognizerRequest field is set.
      • hasCreateCustomClassRequest

        public boolean hasCreateCustomClassRequest()
         The CreateCustomClassRequest that spawned the Operation.
         
        .google.cloud.speech.v2.CreateCustomClassRequest create_custom_class_request = 13;
        Specified by:
        hasCreateCustomClassRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the createCustomClassRequest field is set.
      • hasUpdateCustomClassRequest

        public boolean hasUpdateCustomClassRequest()
         The UpdateCustomClassRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UpdateCustomClassRequest update_custom_class_request = 14;
        Specified by:
        hasUpdateCustomClassRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the updateCustomClassRequest field is set.
      • hasDeleteCustomClassRequest

        public boolean hasDeleteCustomClassRequest()
         The DeleteCustomClassRequest that spawned the Operation.
         
        .google.cloud.speech.v2.DeleteCustomClassRequest delete_custom_class_request = 15;
        Specified by:
        hasDeleteCustomClassRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the deleteCustomClassRequest field is set.
      • hasUndeleteCustomClassRequest

        public boolean hasUndeleteCustomClassRequest()
         The UndeleteCustomClassRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UndeleteCustomClassRequest undelete_custom_class_request = 16;
        Specified by:
        hasUndeleteCustomClassRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the undeleteCustomClassRequest field is set.
      • hasCreatePhraseSetRequest

        public boolean hasCreatePhraseSetRequest()
         The CreatePhraseSetRequest that spawned the Operation.
         
        .google.cloud.speech.v2.CreatePhraseSetRequest create_phrase_set_request = 17;
        Specified by:
        hasCreatePhraseSetRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the createPhraseSetRequest field is set.
      • hasUpdatePhraseSetRequest

        public boolean hasUpdatePhraseSetRequest()
         The UpdatePhraseSetRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UpdatePhraseSetRequest update_phrase_set_request = 18;
        Specified by:
        hasUpdatePhraseSetRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the updatePhraseSetRequest field is set.
      • hasDeletePhraseSetRequest

        public boolean hasDeletePhraseSetRequest()
         The DeletePhraseSetRequest that spawned the Operation.
         
        .google.cloud.speech.v2.DeletePhraseSetRequest delete_phrase_set_request = 19;
        Specified by:
        hasDeletePhraseSetRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the deletePhraseSetRequest field is set.
      • hasUndeletePhraseSetRequest

        public boolean hasUndeletePhraseSetRequest()
         The UndeletePhraseSetRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UndeletePhraseSetRequest undelete_phrase_set_request = 20;
        Specified by:
        hasUndeletePhraseSetRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the undeletePhraseSetRequest field is set.
      • hasUpdateConfigRequest

        @Deprecated
        public boolean hasUpdateConfigRequest()
        Deprecated.
        google.cloud.speech.v2.OperationMetadata.update_config_request is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=419
         The UpdateConfigRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UpdateConfigRequest update_config_request = 21 [deprecated = true];
        Specified by:
        hasUpdateConfigRequest in interface OperationMetadataOrBuilder
        Returns:
        Whether the updateConfigRequest field is set.
      • getUpdateConfigRequest

        @Deprecated
        public UpdateConfigRequest getUpdateConfigRequest()
        Deprecated.
        google.cloud.speech.v2.OperationMetadata.update_config_request is deprecated. See google/cloud/speech/v2/cloud_speech.proto;l=419
         The UpdateConfigRequest that spawned the Operation.
         
        .google.cloud.speech.v2.UpdateConfigRequest update_config_request = 21 [deprecated = true];
        Specified by:
        getUpdateConfigRequest in interface OperationMetadataOrBuilder
        Returns:
        The updateConfigRequest.
      • getProgressPercent

        public int getProgressPercent()
         The percent progress of the Operation. Values can range from 0-100. If the
         value is 100, then the operation is finished.
         
        int32 progress_percent = 22;
        Specified by:
        getProgressPercent in interface OperationMetadataOrBuilder
        Returns:
        The progressPercent.
      • hasBatchRecognizeMetadata

        public boolean hasBatchRecognizeMetadata()
         Metadata specific to the BatchRecognize method.
         
        .google.cloud.speech.v2.BatchRecognizeMetadata batch_recognize_metadata = 23;
        Specified by:
        hasBatchRecognizeMetadata in interface OperationMetadataOrBuilder
        Returns:
        Whether the batchRecognizeMetadata field is set.
      • 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