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
| Name | Datatype | Description |
|---|---|---|
id | string (uint64) | Output only. [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 withRFC1035. 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](?:[-a-z0-9]{0,61}[a-z0-9])?) |
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. [Output Only] Creation timestamp inRFC3339 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 byAIP 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. [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. [Output Only] Server-defined URL for the resource. |
| 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 thanmaxResults, 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. [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 | returnPartialSuccess, orderBy, maxResults, pageToken, filter | 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 usesJSON 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 returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
;
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__attachments,
data__description,
data__intent,
data__interconnectGroup,
data__name,
data__etag,
project,
requestId
)
SELECT
'{{ attachments }}',
'{{ description }}',
'{{ intent }}',
'{{ interconnectGroup }}',
'{{ name }}',
'{{ etag }}',
'{{ project }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
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: "{{ project }}"
description: Required parameter for the interconnect_attachment_groups resource.
- name: attachments
value: "{{ attachments }}"
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: description
value: "{{ description }}"
description: |
An optional description of this resource. Provide this property when you
create the resource.
- name: intent
description: |
The user's intent for this AttachmentGroup. This is the only required field
besides the name that must be specified on group creation.
value:
availabilitySla: "{{ availabilitySla }}"
- name: interconnectGroup
value: "{{ interconnectGroup }}"
description: |
The URL of an InterconnectGroup that groups these Attachments'
Interconnects. Customers do not need to set this unless directed by
Google Support.
- name: name
value: "{{ name }}"
description: |
Name of the resource. Provided by the client when the resource is created.
The name must be 1-63 characters long, and comply withRFC1035.
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: etag
value: "{{ etag }}"
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 byAIP 154.
- name: requestId
value: "{{ requestId }}"
UPDATE examples
- patch
Patches the specified InterconnectAttachmentGroup resource with the data
included in the request. This method supports PATCH
semantics and usesJSON merge
patch format and processing rules.
UPDATE google.compute.interconnect_attachment_groups
SET
data__attachments = '{{ attachments }}',
data__description = '{{ description }}',
data__intent = '{{ intent }}',
data__interconnectGroup = '{{ interconnectGroup }}',
data__name = '{{ name }}',
data__etag = '{{ etag }}'
WHERE
project = '{{ project }}' --required
AND interconnectAttachmentGroup = '{{ interconnectAttachmentGroup }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
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 }}'
;