1. class
  2. Google
  3. \
  4. Cloud
  5. \
  6. OperationResponseMapping

OperationResponseMapping

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

Constants

UNDEFINED

Do not use.

Generated from protobuf enum UNDEFINED = 0;
NAME

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

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

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

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;

Methods

static 
name($value)

No description

static 
value($name)

No description

Details

at line 66
static name($value)

Parameters

$value

at line 76
static value($name)

Parameters

$name