attachments

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

Overview

Name	attachments
Type	Resource
Id	google.apigee.attachments

Fields

The following fields are returned by SELECT queries:

organizations_envgroups_attachments_get

Successful response

Name	Datatype	Description
name	string	ID of the environment group attachment.
createdAt	string (int64)	Output only. The time at which the environment group attachment was created as milliseconds since epoch.
environment	string	Required. ID of the attached environment.
environmentGroupId	string	Output only. ID of the environment group.

organizations_instances_attachments_get

Successful response

Name	Datatype	Description
name	string	Output only. ID of the attachment.
createdAt	string (int64)	Output only. Time the attachment was created in milliseconds since epoch.
environment	string	ID of the attached environment.

organizations_envgroups_attachments_list

Successful response

Name	Datatype	Description
name	string	ID of the environment group attachment.
createdAt	string (int64)	Output only. The time at which the environment group attachment was created as milliseconds since epoch.
environment	string	Required. ID of the attached environment.
environmentGroupId	string	Output only. ID of the environment group.

organizations_instances_attachments_list

Successful response

Name	Datatype	Description
name	string	Output only. ID of the attachment.
createdAt	string (int64)	Output only. Time the attachment was created in milliseconds since epoch.
environment	string	ID of the attached environment.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_envgroups_attachments_get	select	organizationsId, envgroupsId, attachmentsId		Gets an environment group attachment.
organizations_instances_attachments_get	select	organizationsId, instancesId, attachmentsId		Gets an attachment. Note: Not supported for Apigee hybrid.
organizations_envgroups_attachments_list	select	organizationsId, envgroupsId	pageSize, pageToken	Lists all attachments of an environment group.
organizations_instances_attachments_list	select	organizationsId, instancesId	pageSize, pageToken	Lists all attachments to an instance. Note: Not supported for Apigee hybrid.
organizations_envgroups_attachments_create	insert	organizationsId, envgroupsId		Creates a new attachment of an environment to an environment group.
organizations_instances_attachments_create	insert	organizationsId, instancesId		Creates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.
organizations_envgroups_attachments_delete	delete	organizationsId, envgroupsId, attachmentsId		Deletes an environment group attachment.
organizations_instances_attachments_delete	delete	organizationsId, instancesId, attachmentsId		Deletes an attachment. Note: Not supported for Apigee hybrid.

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
attachmentsId	string
envgroupsId	string
instancesId	string
organizationsId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_envgroups_attachments_get

Gets an environment group attachment.

SELECT
name,
createdAt,
environment,
environmentGroupId
FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND envgroupsId = '{{ envgroupsId }}' -- required
AND attachmentsId = '{{ attachmentsId }}' -- required;

organizations_instances_attachments_get

Gets an attachment. Note: Not supported for Apigee hybrid.

SELECT
name,
createdAt,
environment
FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND attachmentsId = '{{ attachmentsId }}' -- required;

organizations_envgroups_attachments_list

Lists all attachments of an environment group.

SELECT
name,
createdAt,
environment,
environmentGroupId
FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND envgroupsId = '{{ envgroupsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

organizations_instances_attachments_list

Lists all attachments to an instance. Note: Not supported for Apigee hybrid.

SELECT
name,
createdAt,
environment
FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' -- required
AND instancesId = '{{ instancesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_envgroups_attachments_create

Creates a new attachment of an environment to an environment group.

INSERT INTO google.apigee.attachments (
data__name,
data__environment,
organizationsId,
envgroupsId
)
SELECT 
'{{ name }}',
'{{ environment }}',
'{{ organizationsId }}',
'{{ envgroupsId }}'
RETURNING
name,
done,
error,
metadata,
response
;

organizations_instances_attachments_create

Creates a new attachment of an environment to an instance. Note: Not supported for Apigee hybrid.

INSERT INTO google.apigee.attachments (
data__environment,
organizationsId,
instancesId
)
SELECT 
'{{ environment }}',
'{{ organizationsId }}',
'{{ instancesId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: attachments
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the attachments resource.
    - name: envgroupsId
      value: string
      description: Required parameter for the attachments resource.
    - name: instancesId
      value: string
      description: Required parameter for the attachments resource.
    - name: name
      value: string
      description: >
        ID of the environment group attachment.
        
    - name: environment
      value: string
      description: >
        ID of the attached environment.
        

DELETE examples

organizations_envgroups_attachments_delete

Deletes an environment group attachment.

DELETE FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' --required
AND envgroupsId = '{{ envgroupsId }}' --required
AND attachmentsId = '{{ attachmentsId }}' --required;

organizations_instances_attachments_delete

Deletes an attachment. Note: Not supported for Apigee hybrid.

DELETE FROM google.apigee.attachments
WHERE organizationsId = '{{ organizationsId }}' --required
AND instancesId = '{{ instancesId }}' --required
AND attachmentsId = '{{ attachmentsId }}' --required;