Google API Common Protos Client - Class OperationResponseMapping (4.8.3)

Version latest

• 4.8.3 (latest)
• 4.8.2

Reference documentation and code samples for the Google API Common Protos Client class OperationResponseMapping.

An enum to be used to mark the essential (for polling) fields in an API-specific Operation object. A custom Operation object may contain many different fields, but only few of them are essential to conduct a successful polling process.

Protobuf type google.cloud.OperationResponseMapping

Namespace

Google \ Cloud

Methods

static::name

Parameter
Name	Description
value	mixed

static::value

Parameter
Name	Description
name	mixed

Constants

UNDEFINED

Value: 0

Do not use.

Generated from protobuf enum UNDEFINED = 0;

NAME

Value: 1

A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.name.

Generated from protobuf enum NAME = 1;

STATUS

Value: 2

A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.done. If the annotated field is of an enum type, annotated_field_name == EnumType.DONE semantics should be equivalent to Operation.done == true. If the annotated field is of type boolean, then it should follow the same semantics as Operation.done.

Otherwise, a non-empty value should be treated as Operation.done == true.

Generated from protobuf enum STATUS = 2;

ERROR_CODE

Value: 3

A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.code.

Generated from protobuf enum ERROR_CODE = 3;

ERROR_MESSAGE

Value: 4

A field in an API-specific (custom) Operation object which carries the same meaning as google.longrunning.Operation.error.message.

Generated from protobuf enum ERROR_MESSAGE = 4;