gc
@datafire/google_compute
npm i @datafire/google_compute
gc

@datafire/google_compute

Integration registry for DataFire

by DataFire

6.0.0 (see all)License:MITTypeScript:Not Found
npm i @datafire/google_compute
Readme

@datafire/google_compute

Client library for Compute Engine API

Installation and Usage

npm install --save @datafire/google_compute
let google_compute = require('@datafire/google_compute').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Creates and runs virtual machines on Google Cloud Platform.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_compute.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_compute.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

compute.globalOrganizationOperations.list

Retrieves a list of Operation resources contained within the specified organization.

google_compute.compute.globalOrganizationOperations.list({}, context)

Input

  • input object
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • parentId string: Parent ID for this request.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.globalOrganizationOperations.delete

Deletes the specified Operations resource.

google_compute.compute.globalOrganizationOperations.delete({
  "operation": ""
}, context)

Input

  • input object
    • operation required string: Name of the Operations resource to delete.
    • parentId string: Parent ID for this request.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

compute.globalOrganizationOperations.get

Retrieves the specified Operations resource. Gets a list of operations by making a list() request.

google_compute.compute.globalOrganizationOperations.get({
  "operation": ""
}, context)

Input

  • input object
    • operation required string: Name of the Operations resource to return.
    • parentId string: Parent ID for this request.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.projects.get

Returns the specified Project resource.

google_compute.compute.projects.get({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.acceleratorTypes.aggregatedList

Retrieves an aggregated list of accelerator types.

google_compute.compute.acceleratorTypes.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.addresses.aggregatedList

Retrieves an aggregated list of addresses.

google_compute.compute.addresses.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.autoscalers.aggregatedList

Retrieves an aggregated list of autoscalers.

google_compute.compute.autoscalers.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.backendServices.aggregatedList

Retrieves the list of all BackendService resources, regional and global, available to the specified project.

google_compute.compute.backendServices.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Name of the project scoping this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.regionCommitments.aggregatedList

Retrieves an aggregated list of commitments.

google_compute.compute.regionCommitments.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.diskTypes.aggregatedList

Retrieves an aggregated list of disk types.

google_compute.compute.diskTypes.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.disks.aggregatedList

Retrieves an aggregated list of persistent disks.

google_compute.compute.disks.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.forwardingRules.aggregatedList

Retrieves an aggregated list of forwarding rules.

google_compute.compute.forwardingRules.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.healthChecks.aggregatedList

Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.

google_compute.compute.healthChecks.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Name of the project scoping this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.instanceGroupManagers.aggregatedList

Retrieves the list of managed instance groups and groups them by zone.

google_compute.compute.instanceGroupManagers.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.instanceGroups.aggregatedList

Retrieves the list of instance groups and sorts them by zone.

google_compute.compute.instanceGroups.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.instances.aggregatedList

Retrieves aggregated list of all of the instances in your project across all regions and zones.

google_compute.compute.instances.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.interconnectAttachments.aggregatedList

Retrieves an aggregated list of interconnect attachments.

google_compute.compute.interconnectAttachments.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.machineTypes.aggregatedList

Retrieves an aggregated list of machine types.

google_compute.compute.machineTypes.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.networkEndpointGroups.aggregatedList

Retrieves the list of network endpoint groups and sorts them by zone.

google_compute.compute.networkEndpointGroups.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.nodeGroups.aggregatedList

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.

google_compute.compute.nodeGroups.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.nodeTemplates.aggregatedList

Retrieves an aggregated list of node templates.

google_compute.compute.nodeTemplates.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.nodeTypes.aggregatedList

Retrieves an aggregated list of node types.

google_compute.compute.nodeTypes.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.globalOperations.aggregatedList

Retrieves an aggregated list of all operations.

google_compute.compute.globalOperations.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.packetMirrorings.aggregatedList

Retrieves an aggregated list of packetMirrorings.

google_compute.compute.packetMirrorings.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.reservations.aggregatedList

Retrieves an aggregated list of reservations.

google_compute.compute.reservations.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.resourcePolicies.aggregatedList

Retrieves an aggregated list of resource policies.

google_compute.compute.resourcePolicies.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
    • maxResults integer: 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)
    • orderBy string: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
    • pageToken string: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
    • returnPartialSuccess boolean: Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

compute.routers.aggregatedList

Retrieves an aggregated list of routers.

google_compute.compute.routers.aggregatedList({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • filter string: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
    • includeAllScopes boolean: Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for

Downloads/wk

2

GitHub Stars

129

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

10

OPEN ISSUES

12

OPEN PRs

16
VersionTagPublished
6.0.0
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial