Google Cloud Network Services V1beta1 Client - Class ExtensionBinding (0.13.1)

Reference documentation and code samples for the Google Cloud Network Services V1beta1 Client class ExtensionBinding.

ExtensionBinding is a resource representing the attachment of an extension to a service.

Generated from protobuf message google.cloud.networkservices.v1beta1.ExtensionBinding

Namespace

Google \ Cloud \ NetworkServices \ V1beta1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Identifier. Name of the ExtensionBinding resource in the following format: projects/{project}/locations/{location}/extensionBindings/{extension_binding}.

↳ create_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was created.

↳ update_time Google\Protobuf\Timestamp

Output only. The timestamp when the resource was updated.

↳ description string

Optional. A human-readable description of the resource.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Set of labels associated with the ExtensionBinding resource. The format must comply with the following requirements.

↳ etag string

Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.

↳ producer_extension string

Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint (see Model Armor integration)

↳ target ExtensionBinding\Target

Required. Specifies a target to which this ExtensionBinding should be attached. The target can be either a single resource or a scope of resources.

↳ match_conditions array<ExtensionBinding\MatchCondition>

Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.

↳ fail_open bool

Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is FALSE. When set to TRUE, failures of the extension are silently ignored.

↳ producer_metadata array|Google\Protobuf\Internal\MapField

Optional. Additional metadata that should be passed to the attached extension with each request.

↳ priority int

Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.

getName

Identifier. Name of the ExtensionBinding resource in the following format: projects/{project}/locations/{location}/extensionBindings/{extension_binding}.

Returns
Type Description
string

setName

Identifier. Name of the ExtensionBinding resource in the following format: projects/{project}/locations/{location}/extensionBindings/{extension_binding}.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The timestamp when the resource was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The timestamp when the resource was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The timestamp when the resource was updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The timestamp when the resource was updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDescription

Optional. A human-readable description of the resource.

Returns
Type Description
string

setDescription

Optional. A human-readable description of the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getLabels

Optional. Set of labels associated with the ExtensionBinding resource.

The format must comply with the following requirements.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Set of labels associated with the ExtensionBinding resource.

The format must comply with the following requirements.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

Optional. Etag of the resource.

If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.

Returns
Type Description
string

setEtag

Optional. Etag of the resource.

If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.

Parameter
Name Description
var string
Returns
Type Description
$this

getProducerExtension

Required. The name of the extension that this binding should attach to target resources.

Format: For Google-provided extensions, specify the service endpoint (see Model Armor integration)

Returns
Type Description
string

setProducerExtension

Required. The name of the extension that this binding should attach to target resources.

Format: For Google-provided extensions, specify the service endpoint (see Model Armor integration)

Parameter
Name Description
var string
Returns
Type Description
$this

getTarget

Required. Specifies a target to which this ExtensionBinding should be attached. The target can be either a single resource or a scope of resources.

Returns
Type Description
ExtensionBinding\Target|null

hasTarget

clearTarget

setTarget

Required. Specifies a target to which this ExtensionBinding should be attached. The target can be either a single resource or a scope of resources.

Parameter
Name Description
var ExtensionBinding\Target
Returns
Type Description
$this

getMatchConditions

Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.

Returns
Type Description
Google\Protobuf\RepeatedField<ExtensionBinding\MatchCondition>

setMatchConditions

Optional. A list of match conditions to match against the incoming request. The extension will be invoked if at least one condition matches the request, or if no match conditions are specified. Limited to 5 conditions.

Parameter
Name Description
var array<ExtensionBinding\MatchCondition>
Returns
Type Description
$this

getFailOpen

Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is FALSE.

When set to TRUE, failures of the extension are silently ignored.

Returns
Type Description
bool

setFailOpen

Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is FALSE.

When set to TRUE, failures of the extension are silently ignored.

Parameter
Name Description
var bool
Returns
Type Description
$this

getProducerMetadata

Optional. Additional metadata that should be passed to the attached extension with each request.

Returns
Type Description
Google\Protobuf\Internal\MapField

setProducerMetadata

Optional. Additional metadata that should be passed to the attached extension with each request.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getPriority

Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.

Returns
Type Description
int

setPriority

Optional. Priority of the extension binding. Lower numbers indicate higher priority. Priority of extension bindings are used to determine the order in which extension bindings are applied to a request.

Parameter
Name Description
var int
Returns
Type Description
$this