REST Resource: projects.locations.clientGateways

Resource: ClientGateway

Message describing ClientGateway object.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "id": string,
  "clientConnectorService": string
}
Fields
name

string

Required. name of resource. The name is ignored during creation.

createTime

string (Timestamp format)

Output only. [Output only] Create time stamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Output only. The operational state of the gateway.

id

string

Output only. A unique identifier for the instance generated by the system.

clientConnectorService

string

Output only. The client connector service name that the client gateway is associated to. Client Connector Services, named as follows: projects/{project_id}/locations/{locationId}/clientConnectorServices/{clientConnectorServiceId}.

State

Represents the different states of a gateway.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
CREATING Gateway is being created.
UPDATING Gateway is being updated.
DELETING Gateway is being deleted.
RUNNING Gateway is running.
DOWN Gateway is down and may be restored in the future. This happens when CCFE sends ProjectState = OFF.
ERROR ClientGateway encountered an error and is in indeterministic state.

Methods

create

Creates a new ClientGateway in a given project and location.

delete

Deletes a single ClientGateway.

get

Gets details of a single ClientGateway.

getIamPolicy

Gets the access control policy for a resource.

list

Lists ClientGateways in a given project and location.

setIamPolicy

Sets the access control policy on the specified resource.

testIamPermissions

Returns permissions that a caller has on the specified resource.