Package com.google.longrunning

Class OperationInfo

  • All Implemented Interfaces:
    OperationInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class OperationInfo
extends com.google.protobuf.GeneratedMessageV3
implements OperationInfoOrBuilder
     A message representing the message types used by a long-running operation.
 Example:
   rpc LongRunningRecognize(LongRunningRecognizeRequest)
       returns (google.longrunning.Operation) {
     option (google.longrunning.operation_info) = {
       response_type: "LongRunningRecognizeResponse"
       metadata_type: "LongRunningRecognizeMetadata"
     };
   }
    Protobuf type google.longrunning.OperationInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  OperationInfo.Builder
      A message representing the message types used by a long-running operation.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int METADATA_TYPE_FIELD_NUMBER  
      static int RESPONSE_TYPE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • RESPONSE_TYPE_FIELD_NUMBER

        public static final int RESPONSE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • METADATA_TYPE_FIELD_NUMBER

        public static final int METADATA_TYPE_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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getResponseType

        public String getResponseType()
         Required. The message name of the primary return type for this
 long-running operation.
 This type will be used to deserialize the LRO's response.
 If the response is in a different package from the rpc, a fully-qualified
 message name must be used (e.g. `google.protobuf.Struct`).
 Note: Altering this value constitutes a breaking change.
        string response_type = 1;
        Specified by:
        getResponseType in interface OperationInfoOrBuilder
        Returns:
        The responseType.

      • getResponseTypeBytes

        public com.google.protobuf.ByteString getResponseTypeBytes()
         Required. The message name of the primary return type for this
 long-running operation.
 This type will be used to deserialize the LRO's response.
 If the response is in a different package from the rpc, a fully-qualified
 message name must be used (e.g. `google.protobuf.Struct`).
 Note: Altering this value constitutes a breaking change.
        string response_type = 1;
        Specified by:
        getResponseTypeBytes in interface OperationInfoOrBuilder
        Returns:
        The bytes for responseType.

      • getMetadataType

        public String getMetadataType()
         Required. The message name of the metadata type for this long-running
 operation.
 If the response is in a different package from the rpc, a fully-qualified
 message name must be used (e.g. `google.protobuf.Struct`).
 Note: Altering this value constitutes a breaking change.
        string metadata_type = 2;
        Specified by:
        getMetadataType in interface OperationInfoOrBuilder
        Returns:
        The metadataType.

      • getMetadataTypeBytes

        public com.google.protobuf.ByteString getMetadataTypeBytes()
         Required. The message name of the metadata type for this long-running
 operation.
 If the response is in a different package from the rpc, a fully-qualified
 message name must be used (e.g. `google.protobuf.Struct`).
 Note: Altering this value constitutes a breaking change.
        string metadata_type = 2;
        Specified by:
        getMetadataTypeBytes in interface OperationInfoOrBuilder
        Returns:
        The bytes for metadataType.

      • 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 OperationInfo parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static OperationInfo getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<OperationInfo> parser()

      • getParserForType

        public com.google.protobuf.Parser<OperationInfo> 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 OperationInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder