Package com.google.cloud
Class ExtendedOperationsProto
- java.lang.Object
-
- com.google.cloud.ExtendedOperationsProto
-
public final class ExtendedOperationsProto extends Object
-
-
Field Summary
Fields Modifier and Type Field Description static int
OPERATION_FIELD_FIELD_NUMBER
static int
OPERATION_POLLING_METHOD_FIELD_NUMBER
static int
OPERATION_REQUEST_FIELD_FIELD_NUMBER
static int
OPERATION_RESPONSE_FIELD_FIELD_NUMBER
static int
OPERATION_SERVICE_FIELD_NUMBER
static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,OperationResponseMapping>
operationField
A field annotation that maps fields in an API-specific Operation object to their standard counterparts in google.longrunning.Operation.static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,Boolean>
operationPollingMethod
A method annotation that marks methods that can be used for polling operation status (e.g.static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,String>
operationRequestField
A field annotation that maps fields in the initial request message (the one which started the LRO) to their counterparts in the polling request message.static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,String>
operationResponseField
A field annotation that maps fields in the polling request message to their counterparts in the initial and/or polling response message.static com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,String>
operationService
A method annotation that maps an LRO method (the one which starts an LRO) to the service, which will be used to poll for the operation status.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static com.google.protobuf.Descriptors.FileDescriptor
getDescriptor()
static void
registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
static void
registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)
-
-
-
Field Detail
-
OPERATION_FIELD_FIELD_NUMBER
public static final int OPERATION_FIELD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
operationField
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,OperationResponseMapping> operationField
A field annotation that maps fields in an API-specific Operation object to their standard counterparts in google.longrunning.Operation. See OperationResponseMapping enum definition.
extend .google.protobuf.FieldOptions { ... }
-
OPERATION_REQUEST_FIELD_FIELD_NUMBER
public static final int OPERATION_REQUEST_FIELD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
operationRequestField
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,String> operationRequestField
A field annotation that maps fields in the initial request message (the one which started the LRO) to their counterparts in the polling request message. For non-standard LRO, the polling response may be missing some of the information needed to make a subsequent polling request. The missing information (for example, project or region ID) is contained in the fields of the initial request message that this annotation must be applied to. The string value of the annotation corresponds to the name of the counterpart field in the polling request message that the annotated field's value will be copied to.
extend .google.protobuf.FieldOptions { ... }
-
OPERATION_RESPONSE_FIELD_FIELD_NUMBER
public static final int OPERATION_RESPONSE_FIELD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
operationResponseField
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.FieldOptions,String> operationResponseField
A field annotation that maps fields in the polling request message to their counterparts in the initial and/or polling response message. The initial and the polling methods return an API-specific Operation object. Some of the fields from that response object must be reused in the subsequent request (like operation name/ID) to fully identify the polled operation. This annotation must be applied to the fields in the polling request message, the string value of the annotation must correspond to the name of the counterpart field in the Operation response object whose value will be copied to the annotated field.
extend .google.protobuf.FieldOptions { ... }
-
OPERATION_SERVICE_FIELD_NUMBER
public static final int OPERATION_SERVICE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
operationService
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,String> operationService
A method annotation that maps an LRO method (the one which starts an LRO) to the service, which will be used to poll for the operation status. The annotation must be applied to the method which starts an LRO, the string value of the annotation must correspond to the name of the service used to poll for the operation status.
extend .google.protobuf.MethodOptions { ... }
-
OPERATION_POLLING_METHOD_FIELD_NUMBER
public static final int OPERATION_POLLING_METHOD_FIELD_NUMBER
- See Also:
- Constant Field Values
-
operationPollingMethod
public static final com.google.protobuf.GeneratedMessage.GeneratedExtension<com.google.protobuf.DescriptorProtos.MethodOptions,Boolean> operationPollingMethod
A method annotation that marks methods that can be used for polling operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).
extend .google.protobuf.MethodOptions { ... }
-
-
Method Detail
-
registerAllExtensions
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistryLite registry)
-
registerAllExtensions
public static void registerAllExtensions(com.google.protobuf.ExtensionRegistry registry)
-
getDescriptor
public static com.google.protobuf.Descriptors.FileDescriptor getDescriptor()
-
-