Method: projects.locations.getRuntimeConfig

Gets the runtimeConfig of a ___location. RuntimeConfig is a singleton resource for each ___location.

HTTP request

GET https://connectors.googleapis.com/v1/{name=projects/*/locations/*/runtimeConfig}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the form: projects/*/locations/*/runtimeConfig

Authorization requires the following IAM permission on the specified resource name:

  • connectors.runtimeconfig.get

Request body

The request body must be empty.

Response body

RuntimeConfig is the singleton resource of each ___location. It includes generic resource configs consumed by control plane and runtime plane like: pub/sub topic/subscription resource name, Cloud Storage ___location storing schema etc.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "locationId": string,
  "conndTopic": string,
  "conndSubscription": string,
  "controlPlaneTopic": string,
  "controlPlaneSubscription": string,
  "runtimeEndpoint": string,
  "state": enum (State),
  "schemaGcsBucket": string,
  "serviceDirectory": string,
  "name": string
}
Fields
locationId

string

Output only. locationId of the runtime ___location. E.g. "us-west1".
conndTopic

string

Output only. Pub/Sub topic for connd to send message. E.g. projects/{project-id}/topics/{topic-id}
conndSubscription

string

Output only. Pub/Sub subscription for connd to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
controlPlaneTopic

string

Output only. Pub/Sub topic for control plne to send message. communication. E.g. projects/{project-id}/topics/{topic-id}
controlPlaneSubscription

string

Output only. Pub/Sub subscription for control plane to receive message. E.g. projects/{project-id}/subscriptions/{topic-id}
runtimeEndpoint

string

Output only. The endpoint of the connectors runtime ingress.
state

enum (State)

Output only. The state of the ___location.
schemaGcsBucket

string

Output only. The Cloud Storage bucket that stores connector's schema reports.
serviceDirectory

string

Output only. The name of the Service Directory service name.
name

string

Output only. Name of the runtimeConfig resource. Format: projects/{project}/locations/{___location}/runtimeConfig

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

State

State of the ___location.

Enums
STATE_UNSPECIFIED STATE_UNSPECIFIED.
INACTIVE

INACTIVE.
ACTIVATING

ACTIVATING.
ACTIVE ACTIVE.
CREATING CREATING.
DELETING DELETING.
UPDATING UPDATING.