Package com.google.longrunning

Class OperationInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<OperationInfo,OperationInfo.Builder>
com.google.longrunning.OperationInfo
All Implemented Interfaces:
OperationInfoOrBuilder, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder
public final class OperationInfo extends com.google.protobuf.GeneratedMessageLite<OperationInfo,OperationInfo.Builder> implements OperationInfoOrBuilder
 A message representing the message types used by a long-running operation.

 Example:

 rpc Export(ExportRequest) returns (google.longrunning.Operation) {
 option (google.longrunning.operation_info) = {
 response_type: "ExportResponse"
 metadata_type: "ExportMetadata"
 };
 }
Protobuf type google.longrunning.OperationInfo

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

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

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static OperationInfo
    getDefaultInstance()
     
    String
    getMetadataType()
    Required.
    com.google.protobuf.ByteString
    getMetadataTypeBytes()
    Required.
    String
    getResponseType()
    Required.
    com.google.protobuf.ByteString
    getResponseTypeBytes()
    Required.
    static OperationInfo.Builder
    newBuilder()
     
    static OperationInfo.Builder
    newBuilder(OperationInfo prototype)
     
    static OperationInfo
    parseDelimitedFrom(InputStream input)
     
    static OperationInfo
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OperationInfo
    parseFrom(byte[] data)
     
    static OperationInfo
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OperationInfo
    parseFrom(com.google.protobuf.ByteString data)
     
    static OperationInfo
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OperationInfo
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static OperationInfo
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OperationInfo
    parseFrom(InputStream input)
     
    static OperationInfo
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static OperationInfo
    parseFrom(ByteBuffer data)
     
    static OperationInfo
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<OperationInfo>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

    • RESPONSE_TYPE_FIELD_NUMBER

      public static final int RESPONSE_TYPE_FIELD_NUMBER
      See Also:

    • METADATA_TYPE_FIELD_NUMBER

      public static final int METADATA_TYPE_FIELD_NUMBER
      See Also:

  • Method Details

    • 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 [json_name = "responseType"];
      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 [json_name = "responseType"];
      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 [json_name = "metadataType"];
      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 [json_name = "metadataType"];
      Specified by:
      getMetadataTypeBytes in interface OperationInfoOrBuilder
      Returns:
      The bytes for metadataType.

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static OperationInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OperationInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static OperationInfo.Builder newBuilder()

    • newBuilder

      public static OperationInfo.Builder newBuilder(OperationInfo prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<OperationInfo,OperationInfo.Builder>

    • getDefaultInstance

      public static OperationInfo getDefaultInstance()

    • parser

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