REST Resource: projects.locations.clientConnectorServices

Resource: ClientConnectorService

Message describing ClientConnectorService object.

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "displayName": string,
  "ingress": {
    object (Ingress)
  },
  "egress": {
    object (Egress)
  },
  "state": enum (State)
}
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".
displayName

string

Optional. User-provided name. The display name should follow certain format. * Must be 6 to 30 characters in length. * Can only contain lowercase letters, numbers, and hyphens. * Must start with a letter.
ingress

object (Ingress)

Required. The details of the ingress settings.
egress

object (Egress)

Required. The details of the egress settings.
state

enum (State)

Output only. The operational state of the ClientConnectorService.

Ingress

Settings of how to connect to the ClientGateway. One of the following options should be set.

JSON representation 
{
  "config": {
    object (Config)
  }
}
Fields
config

object (Config)

The basic ingress config for ClientGateways.

Config

The basic ingress config for ClientGateways.

JSON representation 
{
  "transportProtocol": enum (TransportProtocol),
  "destinationRoutes": [
    {
      object (DestinationRoute)
    }
  ]
}
Fields
transportProtocol

enum (TransportProtocol)

Required. Immutable. The transport protocol used between the client and the server.
destinationRoutes[]

object (DestinationRoute)

Required. The settings used to configure basic ClientGateways.

TransportProtocol

The protocol used to connect to the server.

Enums
TRANSPORT_PROTOCOL_UNSPECIFIED Default value. This value is unused.
TCP TCP protocol.

DestinationRoute

The setting used to configure ClientGateways. It is adding routes to the client's routing table after the connection is established.

JSON representation 
{
  "address": string,
  "netmask": string
}
Fields
address

string

Required. The network address of the subnet for which the packet is routed to the ClientGateway.
netmask

string

Required. The network mask of the subnet for which the packet is routed to the ClientGateway.

Egress

The details of the egress info. One of the following options should be set.

JSON representation 
{
  "peeredVpc": {
    object (PeeredVpc)
  }
}
Fields
peeredVpc

object (PeeredVpc)

A VPC from the consumer project.

PeeredVpc

The peered VPC owned by the consumer project.

JSON representation 
{
  "networkVpc": string
}
Fields
networkVpc

string

Required. The name of the peered VPC owned by the consumer project.

State

Represents the different states of a ClientConnectorService.

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

Methods

create

 Creates a new ClientConnectorService in a given project and location.

delete

 Deletes a single ClientConnectorService.

get

 Gets details of a single ClientConnectorService.

getIamPolicy

 Gets the access control policy for a resource.

list

 Lists ClientConnectorServices in a given project and location.

patch

 Updates the parameters of a single ClientConnectorService.

setIamPolicy

 Sets the access control policy on the specified resource.

testIamPermissions

 Returns permissions that a caller has on the specified resource.