1. class
  2. Google
  3. \
  4. Api
  5. \
  6. BackendRule

BackendRule

class BackendRule extends Message

A backend rule provides configuration for an individual API element.

Generated from protobuf message google.api.BackendRule

Properties

protected $authentication

Methods

__construct(array $data = NULL)

Constructor.

string
getSelector()

Selects the methods to which this rule applies.

$this
setSelector(string $var)

Selects the methods to which this rule applies.

string
getAddress()

The address of the API backend.

$this
setAddress(string $var)

The address of the API backend.

float
getDeadline()

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

$this
setDeadline(float $var)

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

float
getMinDeadline()

Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

$this
setMinDeadline(float $var)

Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

float
getOperationDeadline()

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

$this
setOperationDeadline(float $var)

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

int
getPathTranslation()

Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

$this
setPathTranslation(int $var)

Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

string
getJwtAudience()

The JWT audience is used when generating a JWT ID token for the backend.

$this
setJwtAudience(string $var)

The JWT audience is used when generating a JWT ID token for the backend.

bool
getDisableAuth()

When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.

$this
setDisableAuth(bool $var)

When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.

string
getAuthentication()

No description

Details

at line 93
__construct(array $data = NULL)

Constructor.

Parameters

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

@type string $selector
      Selects the methods to which this rule applies.
      Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
@type string $address
      The address of the API backend.
@type float $deadline
      The number of seconds to wait for a response from a request. The default
      varies based on the request protocol and deployment environment.
@type float $min_deadline
      Minimum deadline in seconds needed for this method. Calls having deadline
      value lower than this will be rejected.
@type float $operation_deadline
      The number of seconds to wait for the completion of a long running
      operation. The default is no deadline.
@type int $path_translation
@type string $jwt_audience
      The JWT audience is used when generating a JWT ID token for the backend.
      This ID token will be added in the HTTP "authorization" header, and sent
      to the backend.
@type bool $disable_auth
      When disable_auth is false,  a JWT ID token will be generated with the
      value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP
      "Authorization" request header and sent to the backend.
      When disable_auth is true, a JWT ID token won't be generated and the
      original "Authorization" HTTP header will be preserved. If the header is
      used to carry the original token and is expected by the backend, this
      field must be set to true to preserve the header.

}

at line 105
string getSelector()

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1;

Return Value

string

at line 118
$this setSelector(string $var)

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Generated from protobuf field string selector = 1;

Parameters

string $var

Return Value

$this

at line 132
string getAddress()

The address of the API backend.

Generated from protobuf field string address = 2;

Return Value

string

at line 144
$this setAddress(string $var)

The address of the API backend.

Generated from protobuf field string address = 2;

Parameters

string $var

Return Value

$this

at line 159
float getDeadline()

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

Generated from protobuf field double deadline = 3;

Return Value

float

at line 172
$this setDeadline(float $var)

The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment.

Generated from protobuf field double deadline = 3;

Parameters

float $var

Return Value

$this

at line 187
float getMinDeadline()

Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

Generated from protobuf field double min_deadline = 4;

Return Value

float

at line 200
$this setMinDeadline(float $var)

Minimum deadline in seconds needed for this method. Calls having deadline value lower than this will be rejected.

Generated from protobuf field double min_deadline = 4;

Parameters

float $var

Return Value

$this

at line 215
float getOperationDeadline()

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

Generated from protobuf field double operation_deadline = 5;

Return Value

float

at line 228
$this setOperationDeadline(float $var)

The number of seconds to wait for the completion of a long running operation. The default is no deadline.

Generated from protobuf field double operation_deadline = 5;

Parameters

float $var

Return Value

$this

at line 240
int getPathTranslation()

Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

Return Value

int

at line 250
$this setPathTranslation(int $var)

Generated from protobuf field .google.api.BackendRule.PathTranslation path_translation = 6;

Parameters

int $var

Return Value

$this

at line 266
string getJwtAudience()

The JWT audience is used when generating a JWT ID token for the backend.

This ID token will be added in the HTTP "authorization" header, and sent to the backend.

Generated from protobuf field string jwt_audience = 7;

Return Value

string

at line 280
$this setJwtAudience(string $var)

The JWT audience is used when generating a JWT ID token for the backend.

This ID token will be added in the HTTP "authorization" header, and sent to the backend.

Generated from protobuf field string jwt_audience = 7;

Parameters

string $var

Return Value

$this

at line 300
bool getDisableAuth()

When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

Generated from protobuf field bool disable_auth = 8;

Return Value

bool

at line 318
$this setDisableAuth(bool $var)

When disable_auth is false, a JWT ID token will be generated with the value from [BackendRule.address][google.api.BackendRule.address] as jwt_audience, overrode to the HTTP "Authorization" request header and sent to the backend.

When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is expected by the backend, this field must be set to true to preserve the header.

Generated from protobuf field bool disable_auth = 8;

Parameters

bool $var

Return Value

$this

at line 329
string getAuthentication()

Return Value

string