PHPFUI/InstaDoc

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

Generated from protobuf message google.longrunning.Operation

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param 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 be a resource name ending with `operations/{unique_id}`.
@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, successful response of the operation.  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`.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearMetadata()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public 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 bool

public getError()

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

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

return \Google\Rpc\Status|null

public 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 \Google\Protobuf\Any|null

public 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 be a resource name ending with operations/{unique_id}.

Generated from protobuf field string name = 1;

return string

public getResponse()

The normal, successful response of the operation. 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 \Google\Protobuf\Any|null

public getResult()

return string

public hasError()

public hasMetadata()

public hasResponse()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setDone( $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;

param bool $var
return $this

public setError( $var)

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

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

param \Google\Rpc\Status $var
return $this

public setMetadata( $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;

param \Google\Protobuf\Any $var
return $this

public setName( $var)

Generated from protobuf field string name = 1;

param string $var
return $this

public setResponse( $var)

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

param \Google\Protobuf\Any $var
return $this

Properties

protected $result = NULL

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $done = false

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;

private $metadata = NULL

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;

private $name = ''

Generated from protobuf field string name = 1;