Class ExtendedOperationsProto (2.41.0)

public final class ExtendedOperationsProto

Inheritance

java.lang.Object > ExtendedOperationsProto

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

OPERATION_FIELD_FIELD_NUMBER

public static final int OPERATION_FIELD_FIELD_NUMBER

Field Value
Type	Description
`int`

OPERATION_POLLING_METHOD_FIELD_NUMBER

public static final int OPERATION_POLLING_METHOD_FIELD_NUMBER

Field Value
Type	Description
`int`

OPERATION_REQUEST_FIELD_FIELD_NUMBER

public static final int OPERATION_REQUEST_FIELD_FIELD_NUMBER

Field Value
Type	Description
`int`

OPERATION_RESPONSE_FIELD_FIELD_NUMBER

public static final int OPERATION_RESPONSE_FIELD_FIELD_NUMBER

Field Value
Type	Description
`int`

OPERATION_SERVICE_FIELD_NUMBER

public static final int OPERATION_SERVICE_FIELD_NUMBER

Field Value
Type	Description
`int`

operationField

public static final GeneratedMessage.GeneratedExtension<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 { ... }

Field Value
Type	Description
`GeneratedExtension<FieldOptions,OperationResponseMapping>`

operationPollingMethod

public static final GeneratedMessage.GeneratedExtension<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 { ... }

Field Value
Type	Description
`GeneratedExtension<MethodOptions,java.lang.Boolean>`

operationRequestField

public static final GeneratedMessage.GeneratedExtension<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 { ... }

Field Value
Type	Description
`GeneratedExtension<FieldOptions,String>`

operationResponseField

public static final GeneratedMessage.GeneratedExtension<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 { ... }

Field Value
Type	Description
`GeneratedExtension<FieldOptions,String>`

operationService

public static final GeneratedMessage.GeneratedExtension<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 { ... }

Field Value
Type	Description
`GeneratedExtension<MethodOptions,String>`

Static Methods

getDescriptor()

public static Descriptors.FileDescriptor getDescriptor()

Returns
Type	Description
`FileDescriptor`

registerAllExtensions(ExtensionRegistry registry)

public static void registerAllExtensions(ExtensionRegistry registry)

Parameter
Name	Description
`registry`	`ExtensionRegistry`

registerAllExtensions(ExtensionRegistryLite registry)

public static void registerAllExtensions(ExtensionRegistryLite registry)

Parameter
Name	Description
`registry`	`ExtensionRegistryLite`