interconnect_attachment_groups

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

Overview

Name	`interconnect_attachment_groups`
Type	Resource
Id	`google.compute.interconnect_attachment_groups`

Fields

The following fields are returned by SELECT queries:

get
list

Successful response

Name	Datatype	Description
`id`	`string (uint64)`	[Output Only] The unique identifier for the resource type. The server generates this identifier.
`name`	`string`	Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. (pattern: a-z?)
`attachments`	`object`	Attachments in the AttachmentGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Attachments per group" quota.
`configured`	`object`	[Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup. (id: InterconnectAttachmentGroupConfigured)
`creationTimestamp`	`string`	[Output Only] Creation timestamp in RFC3339 text format.
`description`	`string`	An optional description of this resource. Provide this property when you create the resource.
`etag`	`string`	Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.
`intent`	`object`	The user's intent for this AttachmentGroup. This is the only required field besides the name that must be specified on group creation. (id: InterconnectAttachmentGroupIntent)
`interconnectGroup`	`string`	The URL of an InterconnectGroup that groups these Attachments' Interconnects. Customers do not need to set this unless directed by Google Support.
`kind`	`string`	[Output Only] Type of the resource. Always compute#interconnectAttachmentGroup. (default: compute#interconnectAttachmentGroup)
`logicalStructure`	`object`	[Output Only] An analysis of the logical layout of Attachments in this group. Every Attachment in the group is shown once in this structure. (id: InterconnectAttachmentGroupLogicalStructure)
`selfLink`	`string`	[Output Only] Server-defined URL for the resource.

Successful response

Name	Datatype	Description
`id`	`string`	[Output Only] Unique identifier for the resource; defined by the server.
`etag`	`string`
`items`	`array`	A list of InterconnectAttachmentGroup resources.
`kind`	`string`	(default: compute#interconnectAttachmentGroup)
`nextPageToken`	`string`	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
`selfLink`	`string`	[Output Only] Server-defined URL for this resource.
`unreachables`	`array`	[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
`warning`	`object`	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`project`, `interconnectAttachmentGroup`		Returns the specified InterconnectAttachmentGroup resource in the given scope.
`list`	`select`	`project`	`filter`, `maxResults`, `orderBy`, `pageToken`, `returnPartialSuccess`	Lists the InterconnectAttachmentGroups for a project in the given scope.
`insert`	`insert`	`project`	`requestId`	Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request.
`patch`	`update`	`project`, `interconnectAttachmentGroup`	`requestId`, `updateMask`	Patches the specified InterconnectAttachmentGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
`delete`	`delete`	`project`, `interconnectAttachmentGroup`	`requestId`	Deletes the specified InterconnectAttachmentGroup in the given scope

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
`interconnectAttachmentGroup`	`string`
`project`	`string`
`filter`	`string`
`maxResults`	`integer (uint32)`
`orderBy`	`string`
`pageToken`	`string`
`requestId`	`string`
`returnPartialSuccess`	`boolean`
`updateMask`	`string (google-fieldmask)`

`SELECT` examples

get
list

Returns the specified InterconnectAttachmentGroup resource in the given scope.

SELECT
id,
name,
attachments,
configured,
creationTimestamp,
description,
etag,
intent,
interconnectGroup,
kind,
logicalStructure,
selfLink
FROM google.compute.interconnect_attachment_groups
WHERE project = '{{ project }}' -- required
AND interconnectAttachmentGroup = '{{ interconnectAttachmentGroup }}' -- required;

Lists the InterconnectAttachmentGroups for a project in the given scope.

SELECT
id,
etag,
items,
kind,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.interconnect_attachment_groups
WHERE project = '{{ project }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND orderBy = '{{ orderBy }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

`INSERT` examples

insert
Manifest

Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request.

INSERT INTO google.compute.interconnect_attachment_groups (
data__kind,
data__id,
data__creationTimestamp,
data__name,
data__description,
data__selfLink,
data__etag,
data__attachments,
data__interconnectGroup,
data__intent,
data__logicalStructure,
data__configured,
project,
requestId
)
SELECT 
'{{ kind }}',
'{{ id }}',
'{{ creationTimestamp }}',
'{{ name }}',
'{{ description }}',
'{{ selfLink }}',
'{{ etag }}',
'{{ attachments }}',
'{{ interconnectGroup }}',
'{{ intent }}',
'{{ logicalStructure }}',
'{{ configured }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

# Description fields are for documentation purposes
- name: interconnect_attachment_groups
  props:
    - name: project
      value: string
      description: Required parameter for the interconnect_attachment_groups resource.
    - name: kind
      value: string
      description: >
        [Output Only] Type of the resource. Always compute#interconnectAttachmentGroup.
        
      default: compute#interconnectAttachmentGroup
    - name: id
      value: string
      description: >
        [Output Only] The unique identifier for the resource type. The server generates this identifier.
        
    - name: creationTimestamp
      value: string
      description: >
        [Output Only] Creation timestamp in RFC3339 text format.
        
    - name: name
      value: string
      description: >
        Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
        
    - name: description
      value: string
      description: >
        An optional description of this resource. Provide this property when you create the resource.
        
    - name: selfLink
      value: string
      description: >
        [Output Only] Server-defined URL for the resource.
        
    - name: etag
      value: string
      description: >
        Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by AIP 154.
        
    - name: attachments
      value: object
      description: >
        Attachments in the AttachmentGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Attachments per group" quota.
        
    - name: interconnectGroup
      value: string
      description: >
        The URL of an InterconnectGroup that groups these Attachments' Interconnects. Customers do not need to set this unless directed by Google Support.
        
    - name: intent
      value: object
      description: >
        The user's intent for this AttachmentGroup. This is the only required field besides the name that must be specified on group creation.
        
    - name: logicalStructure
      value: object
      description: >
        [Output Only] An analysis of the logical layout of Attachments in this group. Every Attachment in the group is shown once in this structure.
        
    - name: configured
      value: object
      description: >
        [Output Only] The redundancy this group is configured to support. The way a user queries what SLA their Attachment gets is by looking at this field of the Attachment's AttachmentGroup.
        
    - name: requestId
      value: string

`UPDATE` examples

patch

Patches the specified InterconnectAttachmentGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.

UPDATE google.compute.interconnect_attachment_groups
SET 
data__kind = '{{ kind }}',
data__id = '{{ id }}',
data__creationTimestamp = '{{ creationTimestamp }}',
data__name = '{{ name }}',
data__description = '{{ description }}',
data__selfLink = '{{ selfLink }}',
data__etag = '{{ etag }}',
data__attachments = '{{ attachments }}',
data__interconnectGroup = '{{ interconnectGroup }}',
data__intent = '{{ intent }}',
data__logicalStructure = '{{ logicalStructure }}',
data__configured = '{{ configured }}'
WHERE 
project = '{{ project }}' --required
AND interconnectAttachmentGroup = '{{ interconnectAttachmentGroup }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone;

`DELETE` examples

delete

Deletes the specified InterconnectAttachmentGroup in the given scope

DELETE FROM google.compute.interconnect_attachment_groups
WHERE project = '{{ project }}' --required
AND interconnectAttachmentGroup = '{{ interconnectAttachmentGroup }}' --required
AND requestId = '{{ requestId }}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​