Google.LongRunning - Class ExtendedOperationsExtensions (3.1.0)

public static class ExtendedOperationsExtensions

Reference documentation and code samples for the Google.LongRunning class ExtendedOperationsExtensions.

Holder for extension identifiers generated from the top level of google/cloud/extended_operations.proto

Inheritance

object > ExtendedOperationsExtensions

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud

Assembly

Google.LongRunning.dll

Fields

OperationField

public static readonly Extension<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.

Field Value
Type	Description
`ExtensionFieldOptionsOperationResponseMapping`

OperationPollingMethod

public static readonly Extension<MethodOptions, bool> OperationPollingMethod

A method annotation that marks methods that can be used for polling operation status (e.g. the MyPollingService.Get(MyPollingRequest) method).

Field Value
Type	Description
`ExtensionMethodOptionsbool`

OperationRequestField

public static readonly Extension<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.

Field Value
Type	Description
`ExtensionFieldOptionsstring`

OperationResponseField

public static readonly Extension<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.

Field Value
Type	Description
`ExtensionFieldOptionsstring`

OperationService

public static readonly Extension<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.

Field Value
Type	Description
`ExtensionMethodOptionsstring`