Documentation

Api extends Message
in package

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

Table of Contents

Properties

$operation  : mixed
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".
$protocol  : mixed
The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
$service  : mixed
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.
$version  : mixed
The API version associated with the API operation above, such as "v1" or "v1alpha1".

Methods

__construct()  : mixed
Constructor.
getOperation()  : string
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".
getProtocol()  : string
The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
getService()  : string
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.
getVersion()  : string
The API version associated with the API operation above, such as "v1" or "v1alpha1".
setOperation()  : $this
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".
setProtocol()  : $this
The API protocol used for sending the request, such as "http", "https", "grpc", or "internal".
setService()  : $this
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.
setVersion()  : $this
The API version associated with the API operation above, such as "v1" or "v1alpha1".

Properties

$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".

protected mixed $operation = ''

Generated from protobuf field string operation = 2 [json_name = "operation"];

$protocol

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

protected mixed $protocol = ''

Generated from protobuf field string protocol = 3 [json_name = "protocol"];

$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.

protected mixed $service = ''

Generated from protobuf field string service = 1 [json_name = "service"];

$version

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

protected mixed $version = ''

Generated from protobuf field string version = 4 [json_name = "version"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ 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".

}

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".

public getOperation() : string

Generated from protobuf field string operation = 2 [json_name = "operation"];

Return values
string

getProtocol()

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

public getProtocol() : string

Generated from protobuf field string protocol = 3 [json_name = "protocol"];

Return values
string

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.

public getService() : string

Generated from protobuf field string service = 1 [json_name = "service"];

Return values
string

getVersion()

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

public getVersion() : string

Generated from protobuf field string version = 4 [json_name = "version"];

Return values
string

setOperation()

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".

public setOperation(string $var) : $this

Generated from protobuf field string operation = 2 [json_name = "operation"];

Parameters
$var : string
Return values
$this

setProtocol()

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

public setProtocol(string $var) : $this

Generated from protobuf field string protocol = 3 [json_name = "protocol"];

Parameters
$var : string
Return values
$this

setService()

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.

public setService(string $var) : $this

Generated from protobuf field string service = 1 [json_name = "service"];

Parameters
$var : string
Return values
$this

setVersion()

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

public setVersion(string $var) : $this

Generated from protobuf field string version = 4 [json_name = "version"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results