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

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

An API that can be served by one or more Gateways.

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

Namespace

Google \ Cloud \ ApiGateway \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. Resource name of the API. Format: projects/{project}/locations/global/apis/{api}

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

↳ managed_service
string

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed ). If not specified, a new Service will automatically be created in the same project as this API.

↳ state
int

Output only. State of the API.

getName

Output only. Resource name of the API.

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

Returns
Type
Description
string

setName

Output only. Resource name of the API.

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. Created time.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. Created time.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. Updated time.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Updated time.

Parameter
Name
Description
Returns
Type
Description
$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
Type
Description

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
Name
Description
Returns
Type
Description
$this

getDisplayName

Optional. Display name.

Returns
Type
Description
string

setDisplayName

Optional. Display name.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getManagedService

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed ). If not specified, a new Service will automatically be created in the same project as this API.

Returns
Type
Description
string

setManagedService

Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed ). If not specified, a new Service will automatically be created in the same project as this API.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getState

Output only. State of the API.

Returns
Type
Description
int

setState

Output only. State of the API.

Parameter
Name
Description
var
int
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: