1. class
  2. Google
  3. \
  4. LongRunning
  5. \
  6. Operation

Operation

class Operation extends Message

This resource represents a long-running operation that is the result of a network API call.

Generated from protobuf message google.longrunning.Operation

Properties

protected $result

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

$this
setName(string $var)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

Any
getMetadata()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

$this
setMetadata(Any $var)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

bool
getDone()

If the value is false, it means the operation is still in progress.

$this
setDone(bool $var)

If the value is false, it means the operation is still in progress.

Status
getError()

The error result of the operation in case of failure or cancellation.

$this
setError(Status $var)

The error result of the operation in case of failure or cancellation.

Any
getResponse()

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

$this
setResponse(Any $var)

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

string
getResult()

No description

Details

at line 78
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $name
      The server-assigned name, which is only unique within the same service that
      originally returns it. If you use the default HTTP mapping, the
      `name` should have the format of `operations/some/unique/name`.
@type \Google\Protobuf\Any $metadata
      Service-specific metadata associated with the operation.  It typically
      contains progress information and common metadata such as create time.
      Some services might not provide such metadata.  Any method that returns a
      long-running operation should document the metadata type, if any.
@type bool $done
      If the value is `false`, it means the operation is still in progress.
      If true, the operation is completed, and either `error` or `response` is
      available.
@type \Google\Rpc\Status $error
      The error result of the operation in case of failure or cancellation.
@type \Google\Protobuf\Any $response
      The normal response of the operation in case of success.  If the original
      method returns no data on success, such as `Delete`, the response is
      `google.protobuf.Empty`.  If the original method is standard
      `Get`/`Create`/`Update`, the response should be the resource.  For other
      methods, the response should have the type `XxxResponse`, where `Xxx`
      is the original method name.  For example, if the original method name
      is `TakeSnapshot()`, the inferred response type is
      `TakeSnapshotResponse`.

}

at line 91
string getName()

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

Generated from protobuf field string name = 1;

Return Value

string

at line 105
$this setName(string $var)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 122
Any getMetadata()

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Generated from protobuf field .google.protobuf.Any metadata = 2;

Return Value

Any

at line 137
$this setMetadata(Any $var)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.

Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

Generated from protobuf field .google.protobuf.Any metadata = 2;

Parameters

Any $var

Return Value

$this

at line 153
bool getDone()

If the value is false, it means the operation is still in progress.

If true, the operation is completed, and either error or response is available.

Generated from protobuf field bool done = 3;

Return Value

bool

at line 167
$this setDone(bool $var)

If the value is false, it means the operation is still in progress.

If true, the operation is completed, and either error or response is available.

Generated from protobuf field bool done = 3;

Parameters

bool $var

Return Value

$this

at line 181
Status getError()

The error result of the operation in case of failure or cancellation.

Generated from protobuf field .google.rpc.Status error = 4;

Return Value

Status

at line 193
$this setError(Status $var)

The error result of the operation in case of failure or cancellation.

Generated from protobuf field .google.rpc.Status error = 4;

Parameters

Status $var

Return Value

$this

at line 214
Any getResponse()

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Generated from protobuf field .google.protobuf.Any response = 5;

Return Value

Any

at line 233
$this setResponse(Any $var)

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Generated from protobuf field .google.protobuf.Any response = 5;

Parameters

Any $var

Return Value

$this

at line 244
string getResult()

Return Value

string