2024-09-28
▼ ▲ compute.interconnectAttachmentGroups.list
Path: projects/{project}/global/interconnectAttachmentGroups
Flat Path: projects/{project}/global/interconnectAttachmentGroups
HTTP Method: GET
Parameters:
filter
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location: query
Type: string
maxResults
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Minimum: 0
Location: query
Type: integer
Format: uint32
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Location: query
Type: string
pageToken
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location: query
Type: boolean
Parameter Order: project
Scopes:
Description: Lists the InterconnectAttachmentGroups for a project in the given scope.
▼ ▲ compute.interconnectAttachmentGroups.get
Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method: GET
Parameters:
interconnectAttachmentGroup
Description: Name of the InterconnectAttachmentGroup resource to return.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Returns the specified InterconnectAttachmentGroup resource in the given scope.
▼ ▲ compute.interconnectAttachmentGroups.insert
Path: projects/{project}/global/interconnectAttachmentGroups
Flat Path: projects/{project}/global/interconnectAttachmentGroups
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
Parameter Order: project
Scopes:
Description: Creates a InterconnectAttachmentGroup in the specified project in the given scope using the parameters that are included in the request.
▼ ▲ compute.interconnectAttachmentGroups.delete
Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method: DELETE
Parameters:
interconnectAttachmentGroup
Description: Name of the InterconnectAttachmentGroup resource to delete.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
Parameter Order:
Scopes:
Description: Deletes the specified InterconnectAttachmentGroup in the given scope
▼ ▲ compute.interconnectAttachmentGroups.patch
Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}
HTTP Method: PATCH
Parameters:
interconnectAttachmentGroup
Description: Name of the InterconnectAttachmentGroup resource to patch.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
updateMask
Description: The list of fields to update.
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Scopes:
Description: 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.
▼ ▲ compute.interconnectAttachmentGroups.getIamPolicy
Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy
HTTP Method: GET
Parameters:
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Location: query
Type: integer
Format: int32
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.interconnectAttachmentGroups.setIamPolicy
Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.interconnectAttachmentGroups.testIamPermissions
Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
Flat Path: projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Returns permissions that a caller has on the specified resource.
▼ ▲ compute.interconnectGroups.list
Path: projects/{project}/global/interconnectGroups
Flat Path: projects/{project}/global/interconnectGroups
HTTP Method: GET
Parameters:
filter
Description: A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Location: query
Type: string
maxResults
Description: The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Default: 500
Minimum: 0
Location: query
Type: integer
Format: uint32
orderBy
Description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Location: query
Type: string
pageToken
Description: Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Location: query
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
returnPartialSuccess
Description: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Location: query
Type: boolean
Parameter Order: project
Scopes:
Description: Lists the InterconnectGroups for a project in the given scope.
▼ ▲ compute.interconnectGroups.get
Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
Flat Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
HTTP Method: GET
Parameters:
interconnectGroup
Description: Name of the InterconnectGroup resource to return.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Returns the specified InterconnectGroup resource in the given scope.
▼ ▲ compute.interconnectGroups.insert
Path: projects/{project}/global/interconnectGroups
Flat Path: projects/{project}/global/interconnectGroups
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
Parameter Order: project
Scopes:
Description: Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request.
▼ ▲ compute.interconnectGroups.delete
Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
Flat Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
HTTP Method: DELETE
Parameters:
interconnectGroup
Description: Name of the InterconnectGroup resource to delete.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
Parameter Order:
Scopes:
Description: Deletes the specified InterconnectGroup in the given scope
▼ ▲ compute.interconnectGroups.patch
Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
Flat Path: projects/{project}/global/interconnectGroups/{interconnectGroup}
HTTP Method: PATCH
Parameters:
interconnectGroup
Description: Name of the InterconnectGroup resource to patch.
Pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
requestId
Description: An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder
Location: query
Type: string
updateMask
Description: The list of fields to update.
Location: query
Type: string
Format: google-fieldmask
Parameter Order:
Scopes:
Description: Patches the specified InterconnectGroup resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
▼ ▲ compute.interconnectGroups.getIamPolicy
Path: projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
Flat Path: projects/{project}/global/interconnectGroups/{resource}/getIamPolicy
HTTP Method: GET
Parameters:
optionsRequestedPolicyVersion
Description: Requested IAM Policy version.
Location: query
Type: integer
Format: int32
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Gets the access control policy for a resource. May be empty if no such policy or resource exists.
▼ ▲ compute.interconnectGroups.setIamPolicy
Path: projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
Flat Path: projects/{project}/global/interconnectGroups/{resource}/setIamPolicy
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Sets the access control policy on the specified resource. Replaces any existing policy.
▼ ▲ compute.interconnectGroups.testIamPermissions
Path: projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
Flat Path: projects/{project}/global/interconnectGroups/{resource}/testIamPermissions
HTTP Method: POST
Parameters:
project
Description: Project ID for this request.
Pattern: (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))
Location: path
Required: Yes
Type: string
resource
Description: Name or id of the resource for this request.
Pattern: [a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}
Location: path
Required: Yes
Type: string
Parameter Order:
Scopes:
Description: Returns permissions that a caller has on the specified resource.