Google Cloud Api Hub V1 Client - Class ApiHubInstance (0.1.3)

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

An ApiHubInstance represents the instance resources of the API Hub.

Currently, only one ApiHub instance is allowed for each project.

Generated from protobuf message google.cloud.apihub.v1.ApiHubInstance

Namespace

Google \ Cloud \ ApiHub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. Format: `projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}`.
`↳ create_time`	`Google\Protobuf\Timestamp` Output only. Creation timestamp.
`↳ update_time`	`Google\Protobuf\Timestamp` Output only. Last update timestamp.
`↳ state`	`int` Output only. The current state of the ApiHub instance.
`↳ state_message`	`string` Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is `FAILED`.
`↳ config`	`ApiHubInstance\Config` Required. Config of the ApiHub instance.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Optional. Instance labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources
`↳ description`	`string` Optional. Description of the ApiHub instance.

getName

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

Returns
Type	Description
`string`

setName

Identifier. Format: projects/{project}/locations/{location}/apiHubInstances/{apiHubInstance}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCreateTime

Output only. Creation timestamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation timestamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getUpdateTime

Output only. Last update timestamp.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Last update timestamp.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$this`

getState

Output only. The current state of the ApiHub instance.

Returns
Type	Description
`int`

setState

Output only. The current state of the ApiHub instance.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getStateMessage

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.

Returns
Type	Description
`string`

setStateMessage

Output only. Extra information about ApiHub instance state. Currently the message would be populated when state is FAILED.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getConfig

Required. Config of the ApiHub instance.

Returns
Type	Description
`ApiHubInstance\Config\|null`

hasConfig

clearConfig

setConfig

Required. Config of the ApiHub instance.

Parameter
Name	Description
`var`	`ApiHubInstance\Config`

Returns
Type	Description
`$this`

getLabels

Optional. Instance 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
`Google\Protobuf\Internal\MapField`

setLabels

Optional. Instance 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
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getDescription

Optional. Description of the ApiHub instance.

Returns
Type	Description
`string`

setDescription

Optional. Description of the ApiHub instance.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`