Operation
class Operation extends Message
This resource represents a long-running operation that is the result of a network API call.
Protobuf type Google\Longrunning\Operation
Properties
| protected | $result |
Methods
No description
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.
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.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time.
If the value is false, it means the operation is still in progress.
If the value is false, it means the operation is still in progress.
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.
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.
No description
Details
at line 46
__construct()
at line 59
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;
at line 72
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;
at line 87
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;
at line 101
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;
at line 115
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;
at line 128
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;
at line 140
Status
getError()
The error result of the operation in case of failure or cancellation.
Generated from protobuf field .google.rpc.Status error = 4;
at line 151
setError(Status $var)
The error result of the operation in case of failure or cancellation.
Generated from protobuf field .google.rpc.Status error = 4;
at line 170
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;
at line 188
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;