endpoint_attachments

Creates, updates, deletes, gets or lists an endpoint_attachments resource.

Overview

Name	endpoint_attachments
Type	Resource
Id	google.apigee.endpoint_attachments

Fields

The following fields are returned by SELECT queries:

organizations_endpoint_attachments_get

Successful response

Name	Datatype	Description
name	string	Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
connectionState	string	Output only. State of the endpoint attachment connection to the service attachment.
host	string	Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.
location	string	Required. Location of the endpoint attachment.
serviceAttachment	string	Format: projects//regions//serviceAttachments/*
state	string	Output only. State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.

organizations_endpoint_attachments_list

Successful response

Name	Datatype	Description
name	string	Name of the endpoint attachment. Use the following structure in your request: organizations/{org}/endpointAttachments/{endpoint_attachment}
connectionState	string	Output only. State of the endpoint attachment connection to the service attachment.
host	string	Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server.
location	string	Required. Location of the endpoint attachment.
serviceAttachment	string	Format: projects//regions//serviceAttachments/*
state	string	Output only. State of the endpoint attachment. Values other than ACTIVE mean the resource is not ready to use.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_endpoint_attachments_get	select	organizationsId, endpointAttachmentsId		Gets the endpoint attachment.
organizations_endpoint_attachments_list	select	organizationsId	pageSize, pageToken	Lists the endpoint attachments in an organization.
organizations_endpoint_attachments_create	insert	organizationsId	endpointAttachmentId	Creates an endpoint attachment. Note: Not supported for Apigee hybrid.
organizations_endpoint_attachments_delete	delete	organizationsId, endpointAttachmentsId		Deletes an endpoint attachment.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpointAttachmentsId	string
organizationsId	string
endpointAttachmentId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_endpoint_attachments_get

Gets the endpoint attachment.

SELECT
name,
connectionState,
host,
location,
serviceAttachment,
state
FROM google.apigee.endpoint_attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND endpointAttachmentsId = '{{ endpointAttachmentsId }}' -- required;

organizations_endpoint_attachments_list

Lists the endpoint attachments in an organization.

SELECT
name,
connectionState,
host,
location,
serviceAttachment,
state
FROM google.apigee.endpoint_attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_endpoint_attachments_create

Creates an endpoint attachment. Note: Not supported for Apigee hybrid.

INSERT INTO google.apigee.endpoint_attachments (
data__name,
data__serviceAttachment,
data__location,
organizationsId,
endpointAttachmentId
)
SELECT 
'{{ name }}',
'{{ serviceAttachment }}',
'{{ location }}',
'{{ organizationsId }}',
'{{ endpointAttachmentId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: endpoint_attachments
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the endpoint_attachments resource.
    - name: name
      value: string
      description: >
        Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}`
        
    - name: serviceAttachment
      value: string
      description: >
        Format: projects/*/regions/*/serviceAttachments/*
        
    - name: location
      value: string
      description: >
        Required. Location of the endpoint attachment.
        
    - name: endpointAttachmentId
      value: string

DELETE examples

organizations_endpoint_attachments_delete

Deletes an endpoint attachment.

DELETE FROM google.apigee.endpoint_attachments
WHERE organizationsId = '{{ organizationsId }}' --required
AND endpointAttachmentsId = '{{ endpointAttachmentsId }}' --required;