REST Resource: projects.locations.serviceConnectionMaps

Resource: ServiceConnectionMap

The ServiceConnectionMap resource. Next id: 15

JSON representation 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "description": string,
  "serviceClass": string,
  "serviceClassUri": string,
  "infrastructure": enum (Infrastructure),
  "producerPscConfigs": [
    {
      object (ProducerPscConfig)
    }
  ],
  "consumerPscConfigs": [
    {
      object (ConsumerPscConfig)
    }
  ],
  "consumerPscConnections": [
    {
      object (ConsumerPscConnection)
    }
  ],
  "token": string,
  "etag": string
}
Fields
name

string

Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{serviceConnectionMap} See: https://google.aip.dev/122#fields-representing-resource-names
createTime

string (Timestamp format)

Output only. Time when the ServiceConnectionMap was created.

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. Time when the ServiceConnectionMap was updated.

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".
labels

map (key: string, value: string)

User-defined labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
description

string

A description of this resource.
serviceClass

string

The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class.
serviceClassUri

string

Output only. The service class uri this ServiceConnectionMap is for.
infrastructure

enum (Infrastructure)

Output only. The infrastructure used for connections between consumers/producers.
producerPscConfigs[]

object (ProducerPscConfig)

The PSC configurations on producer side.
consumerPscConfigs[]

object (ConsumerPscConfig)

The PSC configurations on consumer side.
consumerPscConnections[]

object (ConsumerPscConnection)

Output only. PSC connection details on consumer side.
token

string

The token provided by the consumer. This token authenticates that the consumer can create a connecton within the specified project and network.
etag

string

Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

ProducerPscConfig

The PSC configurations on producer side.

JSON representation 
{
  "serviceAttachmentUri": string
}
Fields
serviceAttachmentUri

string

The resource path of a service attachment. Example: projects/{projectNumOrId}/regions/{region}/serviceAttachments/{resourceId}.

ConsumerPscConfig

Allow the producer to specify which consumers can connect to it.

JSON representation 
{
  "project": string,
  "network": string,
  "disableGlobalAccess": boolean,
  "state": enum (State),
  "producerInstanceId": string,
  "serviceAttachmentIpAddressMap": {
    string: string,
    ...
  },
  "consumerInstanceProject": string,
  "producerInstanceMetadata": {
    string: string,
    ...
  }
}
Fields
project

string

The consumer project where PSC connections are allowed to be created in.
network

string

The resource path of the consumer network where PSC connections are allowed to be created in. Note, this network does not need be in the ConsumerPscConfig.project in the case of SharedVPC. Example: projects/{projectNumOrId}/global/networks/{networkId}.
disableGlobalAccess

boolean

This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region.
state

enum (State)

Output only. Overall state of PSC Connections management for this consumer psc config.
producerInstanceId
(deprecated)

string

Immutable. Deprecated. Use producerInstanceMetadata instead. An immutable identifier for the producer instance.
serviceAttachmentIpAddressMap

map (key: string, value: string)

Output only. A map to store mapping between customer vip and target service attachment. Only service attachment with producer specified ip addresses are stored here.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
consumerInstanceProject

string

Required. The project ID or project number of the consumer project. This project is the one that the consumer uses to interact with the producer instance. From the perspective of a consumer who's created a producer instance, this is the project of the producer instance. Format: 'projects/' Eg. 'projects/consumer-project' or 'projects/1234'
producerInstanceMetadata

map (key: string, value: string)

Immutable. An immutable map for the producer instance metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

State

PSC Consumer Config State.

Enums
STATE_UNSPECIFIED Default state, when Connection Map is created initially.
VALID Set when policy and map configuration is valid, and their matching can lead to allowing creation of PSC Connections subject to other constraints like connections limit.
CONNECTION_POLICY_MISSING No Service Connection Policy found for this network and Service Class
POLICY_LIMIT_REACHED Service Connection Policy limit reached for this network and Service Class
CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED The consumer instance project is not in AllowedGoogleProducersResourceHierarchyLevels of the matching ServiceConnectionPolicy.

ConsumerPscConnection

PSC connection details on consumer side.

JSON representation 
{
  "serviceAttachmentUri": string,
  "state": enum (State),
  "project": string,
  "network": string,
  "pscConnectionId": string,
  "ip": string,
  "errorType": enum (ConnectionErrorType),
  "error": {
    object (Status)
  },
  "gceOperation": string,
  "forwardingRule": string,
  "errorInfo": {
    object (ErrorInfo)
  },
  "selectedSubnetwork": string,
  "producerInstanceId": string,
  "producerInstanceMetadata": {
    string: string,
    ...
  }
}
Fields
serviceAttachmentUri

string

The URI of a service attachment which is the target of the PSC connection.
state

enum (State)

The state of the PSC connection.
project

string

The consumer project whose PSC forwarding rule is connected to the service attachments in this service connection map.
network

string

The consumer network whose PSC forwarding rule is connected to the service attachments in this service connection map. Note that the network could be on a different project (shared VPC).
pscConnectionId

string

The PSC connection id of the PSC forwarding rule connected to the service attachments in this service connection map.
ip

string

The IP literal allocated on the consumer network for the PSC forwarding rule that is created to connect to the producer service attachment in this service connection map.
errorType
(deprecated)

enum (ConnectionErrorType)

The error type indicates whether the error is consumer facing, producer facing or system internal.
error
(deprecated)

object (Status)

The most recent error during operating this connection.
gceOperation

string

The last Compute Engine operation to setup PSC connection.
forwardingRule

string

The URI of the consumer forwarding rule created. Example: projects/{projectNumOrId}/regions/us-east1/networks/{resourceId}.
errorInfo

object (ErrorInfo)

Output only. The error info for the latest error during operating this connection.
selectedSubnetwork

string

Output only. The URI of the selected subnetwork selected to allocate IP address for this connection.
producerInstanceId
(deprecated)

string

Immutable. Deprecated. Use producerInstanceMetadata instead. An immutable identifier for the producer instance.
producerInstanceMetadata

map (key: string, value: string)

Immutable. An immutable map for the producer instance metadata.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

State

The state of the PSC connection.

Enums
STATE_UNSPECIFIED An invalid state as the default case.
ACTIVE The connection has been created successfully. However, for the up-to-date connection status, please use the service attachment's "ConnectedEndpoint.status" as the source of truth.
FAILED The connection is not functional since some resources on the connection fail to be created.
CREATING The connection is being created.
DELETING The connection is being deleted.

Methods

create

 Creates a new ServiceConnectionMap in a given project and location.

delete

 Deletes a single ServiceConnectionMap.

get

 Gets details of a single ServiceConnectionMap.

list

 Lists ServiceConnectionMaps in a given project and location.

patch

 Updates the parameters of a single ServiceConnectionMap.