REST Resource: organizations.endpointAttachments

Resource: EndpointAttachment

Apigee endpoint attachment. For more information, see Southbound networking patterns.

JSON representation
{
  "name": string,
  "location": string,
  "host": string,
  "state": enum (State),
  "connectionState": enum (ConnectionState),

  // Union field destination can be only one of the following:
  "serviceAttachment": string
  // End of list of possible types for union field destination.
}
Fields
name

string

Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpointAttachment}

location

string

Required. Location of the endpoint attachment.

host

string

Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.

state

enum (State)

Output only. State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.

connectionState

enum (ConnectionState)

Output only. State of the endpoint attachment connection to the service attachment.

Union field destination.

destination can be only one of the following:

serviceAttachment

string

Format: projects/*/regions/*/serviceAttachments/*

ConnectionState

The connection state for the underlying connectivity of the Endpoint Attachment.

Enums
CONNECTION_STATE_UNSPECIFIED The connection state has not been set.
UNAVAILABLE The connection state is unavailable at this time, possibly because the endpoint attachment is currently being provisioned.
PENDING The connection is pending acceptance by the PSC producer.
ACCEPTED The connection has been accepted by the PSC producer.
REJECTED The connection has been rejected by the PSC producer.
CLOSED The connection has been closed by the PSC producer and will not serve traffic going forward.
FROZEN The connection has been frozen by the PSC producer and will not serve traffic.
NEEDS_ATTENTION The connection has been accepted by the PSC producer, but it is not ready to serve the traffic due to producer side issues.

Methods

create

Creates an endpoint attachment.

delete

Deletes an endpoint attachment.

get

Gets the endpoint attachment.

list

Lists the endpoint attachments in an organization.