Google Cloud Api Gateway V1 Client - Class Gateway (1.0.5)

Reference documentation and code samples for the Google Cloud Api Gateway V1 Client class Gateway.

A Gateway is an API-aware HTTP proxy. It performs API-Method and/or API-Consumer specific actions based on an API Config such as authentication, policy enforcement, and backend selection.

Generated from protobuf message google.cloud.apigateway.v1.Gateway

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway}

↳ create_time Google\Protobuf\Timestamp

Output only. Created time.

↳ update_time Google\Protobuf\Timestamp

Output only. Updated time.

↳ labels array|Google\Protobuf\Internal\MapField

Optional. Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

↳ display_name string

Optional. Display name.

↳ api_config string

Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

↳ state int

Output only. The current state of the Gateway.

↳ default_hostname string

Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

getName

Output only. Resource name of the Gateway.

Format: projects/{project}/locations/{location}/gateways/{gateway}

Returns
TypeDescription
string

setName

Output only. Resource name of the Gateway.

Format: projects/{project}/locations/{location}/gateways/{gateway}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

Output only. Created time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Created time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

Output only. Updated time.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Updated time.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getLabels

Optional. Resource labels to represent user-provided metadata.

Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Optional. Resource labels to represent user-provided metadata.

Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getDisplayName

Optional. Display name.

Returns
TypeDescription
string

setDisplayName

Optional. Display name.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getApiConfig

Required. Resource name of the API Config for this Gateway.

Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

Returns
TypeDescription
string

setApiConfig

Required. Resource name of the API Config for this Gateway.

Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getState

Output only. The current state of the Gateway.

Returns
TypeDescription
int

setState

Output only. The current state of the Gateway.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDefaultHostname

Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

Returns
TypeDescription
string

setDefaultHostname

Output only. The default API Gateway host name of the form {gateway_id}-{hash}.{region_code}.gateway.dev.

Parameter
NameDescription
var string
Returns
TypeDescription
$this