PHPFUI/InstaDoc

This message defines attributes associated with API operations, such as a network API request. The terminology is based on the conventions used by Google APIs, Istio, and OpenAPI.

Generated from protobuf message google.rpc.context.AttributeContext.Api

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Public
Protected

Methods

public __construct( $data = NULL)

Constructor.

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

@type string $service
      The API service name. It is a logical identifier for a networked API,
      such as "pubsub.googleapis.com". The naming syntax depends on the
      API management system being used for handling the request.
@type string $operation
      The API operation name. For gRPC requests, it is the fully qualified API
      method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI
      requests, it is the `operationId`, such as "getPet".
@type string $protocol
      The API protocol used for sending the request, such as "http", "https",
      "grpc", or "internal".
@type string $version
      The API version associated with the API operation above, such as "v1" or
      "v1alpha1".

}

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 Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getOperation()

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

Generated from protobuf field string operation = 2;

return string

public getProtocol()

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Generated from protobuf field string protocol = 3;

return string

public getService()

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Generated from protobuf field string service = 1;

return string

public getVersion()

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Generated from protobuf field string version = 4;

return string

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 setOperation( $var)

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

Generated from protobuf field string operation = 2;

param string $var
return $this

public setProtocol( $var)

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Generated from protobuf field string protocol = 3;

param string $var
return $this

public setService( $var)

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Generated from protobuf field string service = 1;

param string $var
return $this

public setVersion( $var)

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Generated from protobuf field string version = 4;

param string $var
return $this

Properties

protected $operation = ''

The API operation name. For gRPC requests, it is the fully qualified API method name, such as "google.pubsub.v1.Publisher.Publish". For OpenAPI requests, it is the operationId, such as "getPet".

Generated from protobuf field string operation = 2;

protected $protocol = ''

The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".

Generated from protobuf field string protocol = 3;

protected $service = ''

The API service name. It is a logical identifier for a networked API, such as "pubsub.googleapis.com". The naming syntax depends on the API management system being used for handling the request.

Generated from protobuf field string service = 1;

protected $version = ''

The API version associated with the API operation above, such as "v1" or "v1alpha1".

Generated from protobuf field string version = 4;

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)