@datafire/google_compute

6.0.0 • Public • Published

@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 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.sslCertificates.aggregatedList

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

google_compute.compute.sslCertificates.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.subnetworks.aggregatedList

Retrieves an aggregated list of subnetworks.

google_compute.compute.subnetworks.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.subnetworks.listUsable

Retrieves an aggregated list of all usable subnetworks in the project.

google_compute.compute.subnetworks.listUsable({
  "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 <.
    • 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.targetHttpProxies.aggregatedList

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

google_compute.compute.targetHttpProxies.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.targetHttpsProxies.aggregatedList

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

google_compute.compute.targetHttpsProxies.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.targetInstances.aggregatedList

Retrieves an aggregated list of target instances.

google_compute.compute.targetInstances.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.targetPools.aggregatedList

Retrieves an aggregated list of target pools.

google_compute.compute.targetPools.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.targetVpnGateways.aggregatedList

Retrieves an aggregated list of target VPN gateways.

google_compute.compute.targetVpnGateways.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.urlMaps.aggregatedList

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

google_compute.compute.urlMaps.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.vpnGateways.aggregatedList

Retrieves an aggregated list of VPN gateways.

google_compute.compute.vpnGateways.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.vpnTunnels.aggregatedList

Retrieves an aggregated list of VPN tunnels.

google_compute.compute.vpnTunnels.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.projects.disableXpnHost

Disable this project as a shared VPC host project.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • 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.disableXpnResource

Disable a service resource (also known as service project) associated with this host project.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body ProjectsDisableXpnResourceRequest
    • 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.enableXpnHost

Enable this project as a shared VPC host project.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • 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.enableXpnResource

Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body ProjectsEnableXpnResourceRequest
    • 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.getXpnHost

Gets the shared VPC host project that this project links to. May be empty if no link exists.

google_compute.compute.projects.getXpnHost({
  "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.projects.getXpnResources

Gets service resources (a.k.a service project) associated with this host project.

google_compute.compute.projects.getXpnResources({
  "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 <.
    • 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.globalAddresses.list

Retrieves a list of global addresses.

google_compute.compute.globalAddresses.list({
  "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 <.
    • 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.globalAddresses.insert

Creates an address resource in the specified project by using the data included in the request.

google_compute.compute.globalAddresses.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body Address
    • 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.globalAddresses.delete

Deletes the specified address resource.

google_compute.compute.globalAddresses.delete({
  "project": "",
  "address": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • address required string: Name of the address resource to delete.
    • requestId string: 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.
    • 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.globalAddresses.get

Returns the specified address resource. Gets a list of available addresses by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • address required string: Name of the address resource to return.
    • 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.backendBuckets.list

Retrieves the list of BackendBucket resources available to the specified project.

google_compute.compute.backendBuckets.list({
  "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 <.
    • 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.backendBuckets.insert

Creates a BackendBucket resource in the specified project using the data included in the request.

google_compute.compute.backendBuckets.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body BackendBucket
    • 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.backendBuckets.delete

Deletes the specified BackendBucket resource.

google_compute.compute.backendBuckets.delete({
  "project": "",
  "backendBucket": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to delete.
    • requestId string: 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.
    • 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.backendBuckets.get

Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to return.
    • 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.backendBuckets.patch

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

google_compute.compute.backendBuckets.patch({
  "project": "",
  "backendBucket": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to patch.
    • requestId string: 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.
    • body BackendBucket
    • 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.backendBuckets.update

Updates the specified BackendBucket resource with the data included in the request.

google_compute.compute.backendBuckets.update({
  "project": "",
  "backendBucket": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to update.
    • requestId string: 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.
    • body BackendBucket
    • 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.backendBuckets.addSignedUrlKey

Adds a key for validating requests with signed URLs for this backend bucket.

google_compute.compute.backendBuckets.addSignedUrlKey({
  "project": "",
  "backendBucket": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
    • requestId string: 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.
    • body SignedUrlKey
    • 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.backendBuckets.deleteSignedUrlKey

Deletes a key for validating requests with signed URLs for this backend bucket.

google_compute.compute.backendBuckets.deleteSignedUrlKey({
  "project": "",
  "backendBucket": "",
  "keyName": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendBucket required string: Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.
    • keyName required string: The name of the Signed URL Key to delete.
    • requestId string: 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.
    • 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.list

Retrieves the list of BackendService resources available to the specified project.

google_compute.compute.backendServices.list({
  "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 <.
    • 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.insert

Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body BackendService
    • 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.delete

Deletes the specified BackendService resource.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to delete.
    • requestId string: 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.
    • 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.get

Returns the specified BackendService resource. Gets a list of available backend services.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to return.
    • 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.patch

Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to patch.
    • requestId string: 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.
    • body BackendService
    • 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.update

Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to update.
    • requestId string: 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.
    • body BackendService
    • 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.addSignedUrlKey

Adds a key for validating requests with signed URLs for this backend service.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
    • requestId string: 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.
    • body SignedUrlKey
    • 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.deleteSignedUrlKey

Deletes a key for validating requests with signed URLs for this backend service.

google_compute.compute.backendServices.deleteSignedUrlKey({
  "project": "",
  "backendService": "",
  "keyName": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.
    • keyName required string: The name of the Signed URL Key to delete.
    • requestId string: 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.
    • 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.getHealth

Gets the most recent health check results for this BackendService.

Example request body:

{ "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" }

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

Input

  • input object
    • project required string
    • backendService required string: Name of the BackendService resource to which the queried instance belongs.
    • body ResourceGroupReference
    • 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.setSecurityPolicy

Sets the security policy for the specified backend service.

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

Input

  • input object
    • project required string: Project ID for this request.
    • backendService required string: Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.
    • requestId string: 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.
    • body SecurityPolicyReference
    • 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.externalVpnGateways.list

Retrieves the list of ExternalVpnGateway available to the specified project.

google_compute.compute.externalVpnGateways.list({
  "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 <.
    • 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.externalVpnGateways.insert

Creates a ExternalVpnGateway in the specified project using the data included in the request.

google_compute.compute.externalVpnGateways.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body ExternalVpnGateway
    • 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.externalVpnGateways.delete

Deletes the specified externalVpnGateway.

google_compute.compute.externalVpnGateways.delete({
  "project": "",
  "externalVpnGateway": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • externalVpnGateway required string: Name of the externalVpnGateways to delete.
    • requestId string: 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.
    • 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.externalVpnGateways.get

Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • externalVpnGateway required string: Name of the externalVpnGateway to return.
    • 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.externalVpnGateways.setLabels

Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.

google_compute.compute.externalVpnGateways.setLabels({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetLabelsRequest
    • 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.externalVpnGateways.testIamPermissions

Returns permissions that a caller has on the specified resource.

google_compute.compute.externalVpnGateways.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.firewalls.list

Retrieves the list of firewall rules available to the specified project.

google_compute.compute.firewalls.list({
  "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 <.
    • 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.firewalls.insert

Creates a firewall rule in the specified project using the data included in the request.

google_compute.compute.firewalls.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body Firewall
    • 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.firewalls.delete

Deletes the specified firewall.

google_compute.compute.firewalls.delete({
  "project": "",
  "firewall": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • firewall required string: Name of the firewall rule to delete.
    • requestId string: 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.
    • 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.firewalls.get

Returns the specified firewall.

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

Input

  • input object
    • project required string: Project ID for this request.
    • firewall required string: Name of the firewall rule to return.
    • 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.firewalls.patch

Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

google_compute.compute.firewalls.patch({
  "project": "",
  "firewall": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • firewall required string: Name of the firewall rule to patch.
    • requestId string: 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.
    • body Firewall
    • 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.firewalls.update

Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead.

google_compute.compute.firewalls.update({
  "project": "",
  "firewall": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • firewall required string: Name of the firewall rule to update.
    • requestId string: 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.
    • body Firewall
    • 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.globalForwardingRules.list

Retrieves a list of GlobalForwardingRule resources available to the specified project.

google_compute.compute.globalForwardingRules.list({
  "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 <.
    • 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.globalForwardingRules.insert

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

google_compute.compute.globalForwardingRules.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body ForwardingRule
    • 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.globalForwardingRules.delete

Deletes the specified GlobalForwardingRule resource.

google_compute.compute.globalForwardingRules.delete({
  "project": "",
  "forwardingRule": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • forwardingRule required string: Name of the ForwardingRule resource to delete.
    • requestId string: 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.
    • 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.globalForwardingRules.get

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • forwardingRule required string: Name of the ForwardingRule resource to return.
    • 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.globalForwardingRules.patch

Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.

google_compute.compute.globalForwardingRules.patch({
  "project": "",
  "forwardingRule": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • forwardingRule required string: Name of the ForwardingRule resource to patch.
    • requestId string: 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.
    • body ForwardingRule
    • 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.globalForwardingRules.setTarget

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

google_compute.compute.globalForwardingRules.setTarget({
  "project": "",
  "forwardingRule": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • forwardingRule required string: Name of the ForwardingRule resource in which target is to be set.
    • requestId string: 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.
    • body TargetReference
    • 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.list

Retrieves the list of HealthCheck resources available to the specified project.

google_compute.compute.healthChecks.list({
  "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 <.
    • 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.insert

Creates a HealthCheck resource in the specified project using the data included in the request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body HealthCheck
    • 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.delete

Deletes the specified HealthCheck resource.

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

Input

  • input object
    • project required string: Project ID for this request.
    • healthCheck required string: Name of the HealthCheck resource to delete.
    • requestId string: 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.
    • 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.get

Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • healthCheck required string: Name of the HealthCheck resource to return.
    • 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.patch

Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

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

Input

  • input object
    • project required string: Project ID for this request.
    • healthCheck required string: Name of the HealthCheck resource to patch.
    • requestId string: 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.
    • body HealthCheck
    • 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.update

Updates a HealthCheck resource in the specified project using the data included in the request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • healthCheck required string: Name of the HealthCheck resource to update.
    • requestId string: 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.
    • body HealthCheck
    • 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.httpHealthChecks.list

Retrieves the list of HttpHealthCheck resources available to the specified project.

google_compute.compute.httpHealthChecks.list({
  "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 <.
    • 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.httpHealthChecks.insert

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

google_compute.compute.httpHealthChecks.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body HttpHealthCheck
    • 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.httpHealthChecks.delete

Deletes the specified HttpHealthCheck resource.

google_compute.compute.httpHealthChecks.delete({
  "project": "",
  "httpHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpHealthCheck required string: Name of the HttpHealthCheck resource to delete.
    • requestId string: 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.
    • 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.httpHealthChecks.get

Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • httpHealthCheck required string: Name of the HttpHealthCheck resource to return.
    • 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.httpHealthChecks.patch

Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

google_compute.compute.httpHealthChecks.patch({
  "project": "",
  "httpHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpHealthCheck required string: Name of the HttpHealthCheck resource to patch.
    • requestId string: 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.
    • body HttpHealthCheck
    • 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.httpHealthChecks.update

Updates a HttpHealthCheck resource in the specified project using the data included in the request.

google_compute.compute.httpHealthChecks.update({
  "project": "",
  "httpHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpHealthCheck required string: Name of the HttpHealthCheck resource to update.
    • requestId string: 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.
    • body HttpHealthCheck
    • 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.httpsHealthChecks.list

Retrieves the list of HttpsHealthCheck resources available to the specified project.

google_compute.compute.httpsHealthChecks.list({
  "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 <.
    • 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.httpsHealthChecks.insert

Creates a HttpsHealthCheck resource in the specified project using the data included in the request.

google_compute.compute.httpsHealthChecks.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body HttpsHealthCheck
    • 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.httpsHealthChecks.delete

Deletes the specified HttpsHealthCheck resource.

google_compute.compute.httpsHealthChecks.delete({
  "project": "",
  "httpsHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpsHealthCheck required string: Name of the HttpsHealthCheck resource to delete.
    • requestId string: 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.
    • 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.httpsHealthChecks.get

Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • httpsHealthCheck required string: Name of the HttpsHealthCheck resource to return.
    • 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.httpsHealthChecks.patch

Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

google_compute.compute.httpsHealthChecks.patch({
  "project": "",
  "httpsHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpsHealthCheck required string: Name of the HttpsHealthCheck resource to patch.
    • requestId string: 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.
    • body HttpsHealthCheck
    • 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.httpsHealthChecks.update

Updates a HttpsHealthCheck resource in the specified project using the data included in the request.

google_compute.compute.httpsHealthChecks.update({
  "project": "",
  "httpsHealthCheck": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • httpsHealthCheck required string: Name of the HttpsHealthCheck resource to update.
    • requestId string: 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.
    • body HttpsHealthCheck
    • 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.images.list

Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.

google_compute.compute.images.list({
  "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 <.
    • 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.images.insert

Creates an image in the specified project using the data included in the request.

google_compute.compute.images.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • forceCreate boolean: Force image creation if true.
    • requestId string: 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.
    • body Image
    • 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.images.getFromFamily

Returns the latest image that is part of an image family and is not deprecated.

google_compute.compute.images.getFromFamily({
  "project": "",
  "family": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • family required string: Name of the image family to search for.
    • 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.images.delete

Deletes the specified image.

google_compute.compute.images.delete({
  "project": "",
  "image": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • image required string: Name of the image resource to delete.
    • requestId string: 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.
    • 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.images.get

Returns the specified image. Gets a list of available images by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • image required string: Name of the image resource to return.
    • 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.images.patch

Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status.

google_compute.compute.images.patch({
  "project": "",
  "image": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • image required string: Name of the image resource to patch.
    • requestId string: 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.
    • body Image
    • 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.images.deprecate

Sets the deprecation status of an image.

If an empty request body is given, clears the deprecation status instead.

google_compute.compute.images.deprecate({
  "project": "",
  "image": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • image required string: Image name.
    • requestId string: 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.
    • body DeprecationStatus
    • 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.images.getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

google_compute.compute.images.getIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • optionsRequestedPolicyVersion integer: Requested IAM Policy version.
    • 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.images.setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

google_compute.compute.images.setIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetPolicyRequest
    • 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.images.setLabels

Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.

google_compute.compute.images.setLabels({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetLabelsRequest
    • 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.images.testIamPermissions

Returns permissions that a caller has on the specified resource.

google_compute.compute.images.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.instanceTemplates.list

Retrieves a list of instance templates that are contained within the specified project.

google_compute.compute.instanceTemplates.list({
  "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 <.
    • 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.instanceTemplates.insert

Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.

google_compute.compute.instanceTemplates.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body InstanceTemplate
    • 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.instanceTemplates.delete

Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group.

google_compute.compute.instanceTemplates.delete({
  "project": "",
  "instanceTemplate": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • instanceTemplate required string: The name of the instance template to delete.
    • requestId string: 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.
    • 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.instanceTemplates.get

Returns the specified instance template. Gets a list of available instance templates by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • instanceTemplate required string: The name of the instance template.
    • 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.instanceTemplates.getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

google_compute.compute.instanceTemplates.getIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • optionsRequestedPolicyVersion integer: Requested IAM Policy version.
    • 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.instanceTemplates.setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

google_compute.compute.instanceTemplates.setIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetPolicyRequest
    • 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.instanceTemplates.testIamPermissions

Returns permissions that a caller has on the specified resource.

google_compute.compute.instanceTemplates.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.interconnectLocations.list

Retrieves the list of interconnect locations available to the specified project.

google_compute.compute.interconnectLocations.list({
  "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 <.
    • 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.interconnectLocations.get

Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • interconnectLocation required string: Name of the interconnect location to return.
    • 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.interconnects.list

Retrieves the list of interconnect available to the specified project.

google_compute.compute.interconnects.list({
  "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 <.
    • 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.interconnects.insert

Creates a Interconnect in the specified project using the data included in the request.

google_compute.compute.interconnects.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body Interconnect
    • 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.interconnects.delete

Deletes the specified interconnect.

google_compute.compute.interconnects.delete({
  "project": "",
  "interconnect": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • interconnect required string: Name of the interconnect to delete.
    • requestId string: 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.
    • 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.interconnects.get

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • interconnect required string: Name of the interconnect to return.
    • 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.interconnects.patch

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

google_compute.compute.interconnects.patch({
  "project": "",
  "interconnect": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • interconnect required string: Name of the interconnect to update.
    • requestId string: 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.
    • body Interconnect
    • 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.interconnects.getDiagnostics

Returns the interconnectDiagnostics for the specified interconnect.

google_compute.compute.interconnects.getDiagnostics({
  "project": "",
  "interconnect": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • interconnect required string: Name of the interconnect resource to query.
    • 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.licenseCodes.get

Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

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

Input

  • input object
    • project required string: Project ID for this request.
    • licenseCode required string: Number corresponding to the License code resource to return.
    • 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.licenseCodes.testIamPermissions

Returns permissions that a caller has on the specified resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenseCodes.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.licenses.list

Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.list({
  "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 <.
    • 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.licenses.insert

Create a License resource in the specified project. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body License
    • 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.licenses.delete

Deletes the specified license. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.delete({
  "project": "",
  "license": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • license required string: Name of the license resource to delete.
    • requestId string: 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.
    • 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.licenses.get

Returns the specified License resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

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

Input

  • input object
    • project required string: Project ID for this request.
    • license required string: Name of the License resource to return.
    • 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.licenses.getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.getIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • optionsRequestedPolicyVersion integer: Requested IAM Policy version.
    • 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.licenses.setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.setIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetPolicyRequest
    • 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.licenses.testIamPermissions

Returns permissions that a caller has on the specified resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

google_compute.compute.licenses.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.globalNetworkEndpointGroups.list

Retrieves the list of network endpoint groups that are located in the specified project.

google_compute.compute.globalNetworkEndpointGroups.list({
  "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 <.
    • 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.globalNetworkEndpointGroups.insert

Creates a network endpoint group in the specified project using the parameters that are included in the request.

google_compute.compute.globalNetworkEndpointGroups.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body NetworkEndpointGroup
    • 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.globalNetworkEndpointGroups.delete

Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

google_compute.compute.globalNetworkEndpointGroups.delete({
  "project": "",
  "networkEndpointGroup": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • networkEndpointGroup required string: The name of the network endpoint group to delete. It should comply with RFC1035.
    • requestId string: 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.
    • 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.globalNetworkEndpointGroups.get

Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • networkEndpointGroup required string: The name of the network endpoint group. It should comply with RFC1035.
    • 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.globalNetworkEndpointGroups.attachNetworkEndpoints

Attach a network endpoint to the specified network endpoint group.

google_compute.compute.globalNetworkEndpointGroups.attachNetworkEndpoints({
  "project": "",
  "networkEndpointGroup": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • networkEndpointGroup required string: The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.
    • requestId string: 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.
    • body GlobalNetworkEndpointGroupsAttachEndpointsRequest
    • 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.globalNetworkEndpointGroups.detachNetworkEndpoints

Detach the network endpoint from the specified network endpoint group.

google_compute.compute.globalNetworkEndpointGroups.detachNetworkEndpoints({
  "project": "",
  "networkEndpointGroup": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • networkEndpointGroup required string: The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.
    • requestId string: 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.
    • body GlobalNetworkEndpointGroupsDetachEndpointsRequest
    • 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.globalNetworkEndpointGroups.listNetworkEndpoints

Lists the network endpoints in the specified network endpoint group.

google_compute.compute.globalNetworkEndpointGroups.listNetworkEndpoints({
  "project": "",
  "networkEndpointGroup": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • networkEndpointGroup required string: The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.
    • 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.
    • 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.networks.list

Retrieves the list of networks available to the specified project.

google_compute.compute.networks.list({
  "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 <.
    • 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.networks.insert

Creates a network in the specified project using the data included in the request.

google_compute.compute.networks.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body Network
    • 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.networks.delete

Deletes the specified network.

google_compute.compute.networks.delete({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network to delete.
    • requestId string: 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.
    • 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.networks.get

Returns the specified network. Gets a list of available networks by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network to return.
    • 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.networks.patch

Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.

google_compute.compute.networks.patch({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network to update.
    • requestId string: 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.
    • body Network
    • 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.networks.addPeering

Adds a peering to the specified network.

google_compute.compute.networks.addPeering({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network resource to add peering to.
    • requestId string: 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.
    • body NetworksAddPeeringRequest
    • 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.networks.listPeeringRoutes

Lists the peering routes exchanged over peering connection.

google_compute.compute.networks.listPeeringRoutes({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network for this request.
    • direction string (values: INCOMING, OUTGOING): The direction of the exchanged routes.
    • 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.
    • peeringName string: The response will show routes exchanged over the given peering connection.
    • region string: The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.
    • 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.networks.removePeering

Removes a peering from the specified network.

google_compute.compute.networks.removePeering({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network resource to remove peering from.
    • requestId string: 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.
    • body NetworksRemovePeeringRequest
    • 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.networks.switchToCustomMode

Switches the network mode from auto subnet mode to custom subnet mode.

google_compute.compute.networks.switchToCustomMode({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network to be updated.
    • requestId string: 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.
    • 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.networks.updatePeering

Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes

google_compute.compute.networks.updatePeering({
  "project": "",
  "network": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • network required string: Name of the network resource which the updated peering is belonging to.
    • requestId string: 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.
    • body NetworksUpdatePeeringRequest
    • 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.list

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

google_compute.compute.globalOperations.list({
  "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 <.
    • 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.delete

Deletes the specified Operations resource.

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

Input

  • input object
    • project required string: Project ID for this request.
    • operation required string: Name of the Operations resource to delete.
    • 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.globalOperations.get

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

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

Input

  • input object
    • project required string: Project ID for this request.
    • operation required string: Name of the Operations resource to return.
    • 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.wait

Waits for the specified Operation resource to return as DONE or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the GET method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be DONE or still in progress.

This method is called on a best-effort basis. Specifically:

  • In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds.
  • If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not DONE.
google_compute.compute.globalOperations.wait({
  "project": "",
  "operation": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • operation required string: Name of the Operations resource to return.
    • 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.routes.list

Retrieves the list of Route resources available to the specified project.

google_compute.compute.routes.list({
  "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 <.
    • 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.routes.insert

Creates a Route resource in the specified project using the data included in the request.

google_compute.compute.routes.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body Route
    • 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.routes.delete

Deletes the specified Route resource.

google_compute.compute.routes.delete({
  "project": "",
  "route": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • route required string: Name of the Route resource to delete.
    • requestId string: 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.
    • 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.routes.get

Returns the specified Route resource. Gets a list of available routes by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • route required string: Name of the Route resource to return.
    • 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.securityPolicies.list

List all the policies that have been configured for the specified project.

google_compute.compute.securityPolicies.list({
  "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 <.
    • 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.securityPolicies.insert

Creates a new policy in the specified project using the data included in the request.

google_compute.compute.securityPolicies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body SecurityPolicy
    • 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.securityPolicies.listPreconfiguredExpressionSets

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

google_compute.compute.securityPolicies.listPreconfiguredExpressionSets({
  "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 <.
    • 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.securityPolicies.delete

Deletes the specified policy.

google_compute.compute.securityPolicies.delete({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to delete.
    • requestId string: 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.
    • 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.securityPolicies.get

List all of the ordered rules present in a single specified policy.

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

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to get.
    • 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.securityPolicies.patch

Patches the specified policy with the data included in the request. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead.

google_compute.compute.securityPolicies.patch({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to update.
    • requestId string: 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.
    • body SecurityPolicy
    • 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.securityPolicies.addRule

Inserts a rule into a security policy.

google_compute.compute.securityPolicies.addRule({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to update.
    • body SecurityPolicyRule
    • 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.securityPolicies.getRule

Gets a rule at the specified priority.

google_compute.compute.securityPolicies.getRule({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to which the queried rule belongs.
    • priority integer: The priority of the rule to get from the security policy.
    • 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.securityPolicies.patchRule

Patches a rule at the specified priority.

google_compute.compute.securityPolicies.patchRule({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to update.
    • priority integer: The priority of the rule to patch.
    • body SecurityPolicyRule
    • 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.securityPolicies.removeRule

Deletes a rule at the specified priority.

google_compute.compute.securityPolicies.removeRule({
  "project": "",
  "securityPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • securityPolicy required string: Name of the security policy to update.
    • priority integer: The priority of the rule to remove from the security policy.
    • 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.snapshots.list

Retrieves the list of Snapshot resources contained within the specified project.

google_compute.compute.snapshots.list({
  "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 <.
    • 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.snapshots.getIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

google_compute.compute.snapshots.getIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • optionsRequestedPolicyVersion integer: Requested IAM Policy version.
    • 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.snapshots.setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

google_compute.compute.snapshots.setIamPolicy({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetPolicyRequest
    • 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.snapshots.setLabels

Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.

google_compute.compute.snapshots.setLabels({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body GlobalSetLabelsRequest
    • 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.snapshots.testIamPermissions

Returns permissions that a caller has on the specified resource.

google_compute.compute.snapshots.testIamPermissions({
  "project": "",
  "resource": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • resource required string: Name or id of the resource for this request.
    • body TestPermissionsRequest
    • 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.snapshots.delete

Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot.

For more information, see Deleting snapshots.

google_compute.compute.snapshots.delete({
  "project": "",
  "snapshot": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • snapshot required string: Name of the Snapshot resource to delete.
    • requestId string: 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.
    • 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.snapshots.get

Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • snapshot required string: Name of the Snapshot resource to return.
    • 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.sslCertificates.list

Retrieves the list of SslCertificate resources available to the specified project.

google_compute.compute.sslCertificates.list({
  "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 <.
    • 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.sslCertificates.insert

Creates a SslCertificate resource in the specified project using the data included in the request.

google_compute.compute.sslCertificates.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body SslCertificate
    • 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.sslCertificates.delete

Deletes the specified SslCertificate resource.

google_compute.compute.sslCertificates.delete({
  "project": "",
  "sslCertificate": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • sslCertificate required string: Name of the SslCertificate resource to delete.
    • requestId string: 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.
    • 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.sslCertificates.get

Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • sslCertificate required string: Name of the SslCertificate resource to return.
    • 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.sslPolicies.list

Lists all the SSL policies that have been configured for the specified project.

google_compute.compute.sslPolicies.list({
  "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 <.
    • 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.sslPolicies.insert

Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.

google_compute.compute.sslPolicies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body SslPolicy
    • 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.sslPolicies.listAvailableFeatures

Lists all features that can be specified in the SSL policy when using custom profile.

google_compute.compute.sslPolicies.listAvailableFeatures({
  "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 <.
    • 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.sslPolicies.delete

Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources.

google_compute.compute.sslPolicies.delete({
  "project": "",
  "sslPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • sslPolicy required string: Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.
    • requestId string: 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.
    • 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.sslPolicies.get

Lists all of the ordered rules present in a single specified policy.

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

Input

  • input object
    • project required string: Project ID for this request.
    • sslPolicy required string: Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
    • 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.sslPolicies.patch

Patches the specified SSL policy with the data included in the request.

google_compute.compute.sslPolicies.patch({
  "project": "",
  "sslPolicy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • sslPolicy required string: Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.
    • requestId string: 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.
    • body SslPolicy
    • 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.targetGrpcProxies.list

Lists the TargetGrpcProxies for a project in the given scope.

google_compute.compute.targetGrpcProxies.list({
  "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 <.
    • 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.targetGrpcProxies.insert

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

google_compute.compute.targetGrpcProxies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body TargetGrpcProxy
    • 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.targetGrpcProxies.delete

Deletes the specified TargetGrpcProxy in the given scope

google_compute.compute.targetGrpcProxies.delete({
  "project": "",
  "targetGrpcProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetGrpcProxy required string: Name of the TargetGrpcProxy resource to delete.
    • requestId string: 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.
    • 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.targetGrpcProxies.get

Returns the specified TargetGrpcProxy resource in the given scope.

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

Input

  • input object
    • project required string: Project ID for this request.
    • targetGrpcProxy required string: Name of the TargetGrpcProxy resource to return.
    • 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.targetGrpcProxies.patch

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

google_compute.compute.targetGrpcProxies.patch({
  "project": "",
  "targetGrpcProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetGrpcProxy required string: Name of the TargetGrpcProxy resource to patch.
    • requestId string: 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.
    • body TargetGrpcProxy
    • 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.targetHttpProxies.list

Retrieves the list of TargetHttpProxy resources available to the specified project.

google_compute.compute.targetHttpProxies.list({
  "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 <.
    • 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.targetHttpProxies.insert

Creates a TargetHttpProxy resource in the specified project using the data included in the request.

google_compute.compute.targetHttpProxies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body TargetHttpProxy
    • 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.targetHttpProxies.delete

Deletes the specified TargetHttpProxy resource.

google_compute.compute.targetHttpProxies.delete({
  "project": "",
  "targetHttpProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpProxy required string: Name of the TargetHttpProxy resource to delete.
    • requestId string: 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.
    • 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.targetHttpProxies.get

Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpProxy required string: Name of the TargetHttpProxy resource to return.
    • 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.targetHttpProxies.patch

Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. (== suppress_warning http-rest-shadowed ==)

google_compute.compute.targetHttpProxies.patch({
  "project": "",
  "targetHttpProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpProxy required string: Name of the TargetHttpProxy resource to patch.
    • requestId string: 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.
    • body TargetHttpProxy
    • 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.targetHttpsProxies.list

Retrieves the list of TargetHttpsProxy resources available to the specified project.

google_compute.compute.targetHttpsProxies.list({
  "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 <.
    • 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.targetHttpsProxies.insert

Creates a TargetHttpsProxy resource in the specified project using the data included in the request.

google_compute.compute.targetHttpsProxies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body TargetHttpsProxy
    • 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.targetHttpsProxies.delete

Deletes the specified TargetHttpsProxy resource.

google_compute.compute.targetHttpsProxies.delete({
  "project": "",
  "targetHttpsProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpsProxy required string: Name of the TargetHttpsProxy resource to delete.
    • requestId string: 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.
    • 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.targetHttpsProxies.get

Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpsProxy required string: Name of the TargetHttpsProxy resource to return.
    • 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.targetHttpsProxies.setQuicOverride

Sets the QUIC override policy for TargetHttpsProxy.

google_compute.compute.targetHttpsProxies.setQuicOverride({
  "project": "",
  "targetHttpsProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpsProxy required string: Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.
    • requestId string: 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.
    • body TargetHttpsProxiesSetQuicOverrideRequest
    • 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.targetHttpsProxies.setSslPolicy

Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends.

google_compute.compute.targetHttpsProxies.setSslPolicy({
  "project": "",
  "targetHttpsProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetHttpsProxy required string: Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
    • requestId string: 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.
    • body SslPolicyReference
    • 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.targetSslProxies.list

Retrieves the list of TargetSslProxy resources available to the specified project.

google_compute.compute.targetSslProxies.list({
  "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 <.
    • 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.targetSslProxies.insert

Creates a TargetSslProxy resource in the specified project using the data included in the request.

google_compute.compute.targetSslProxies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body TargetSslProxy
    • 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.targetSslProxies.delete

Deletes the specified TargetSslProxy resource.

google_compute.compute.targetSslProxies.delete({
  "project": "",
  "targetSslProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource to delete.
    • requestId string: 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.
    • 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.targetSslProxies.get

Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource to return.
    • 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.targetSslProxies.setBackendService

Changes the BackendService for TargetSslProxy.

google_compute.compute.targetSslProxies.setBackendService({
  "project": "",
  "targetSslProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource whose BackendService resource is to be set.
    • requestId string: 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.
    • body TargetSslProxiesSetBackendServiceRequest
    • 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.targetSslProxies.setProxyHeader

Changes the ProxyHeaderType for TargetSslProxy.

google_compute.compute.targetSslProxies.setProxyHeader({
  "project": "",
  "targetSslProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource whose ProxyHeader is to be set.
    • requestId string: 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.
    • body TargetSslProxiesSetProxyHeaderRequest
    • 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.targetSslProxies.setSslCertificates

Changes SslCertificates for TargetSslProxy.

google_compute.compute.targetSslProxies.setSslCertificates({
  "project": "",
  "targetSslProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource whose SslCertificate resource is to be set.
    • requestId string: 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.
    • body TargetSslProxiesSetSslCertificatesRequest
    • 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.targetSslProxies.setSslPolicy

Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends.

google_compute.compute.targetSslProxies.setSslPolicy({
  "project": "",
  "targetSslProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetSslProxy required string: Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.
    • requestId string: 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.
    • body SslPolicyReference
    • 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.targetTcpProxies.list

Retrieves the list of TargetTcpProxy resources available to the specified project.

google_compute.compute.targetTcpProxies.list({
  "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 <.
    • 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.targetTcpProxies.insert

Creates a TargetTcpProxy resource in the specified project using the data included in the request.

google_compute.compute.targetTcpProxies.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body TargetTcpProxy
    • 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.targetTcpProxies.delete

Deletes the specified TargetTcpProxy resource.

google_compute.compute.targetTcpProxies.delete({
  "project": "",
  "targetTcpProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetTcpProxy required string: Name of the TargetTcpProxy resource to delete.
    • requestId string: 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.
    • 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.targetTcpProxies.get

Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • targetTcpProxy required string: Name of the TargetTcpProxy resource to return.
    • 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.targetTcpProxies.setBackendService

Changes the BackendService for TargetTcpProxy.

google_compute.compute.targetTcpProxies.setBackendService({
  "project": "",
  "targetTcpProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetTcpProxy required string: Name of the TargetTcpProxy resource whose BackendService resource is to be set.
    • requestId string: 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.
    • body TargetTcpProxiesSetBackendServiceRequest
    • 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.targetTcpProxies.setProxyHeader

Changes the ProxyHeaderType for TargetTcpProxy.

google_compute.compute.targetTcpProxies.setProxyHeader({
  "project": "",
  "targetTcpProxy": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • targetTcpProxy required string: Name of the TargetTcpProxy resource whose ProxyHeader is to be set.
    • requestId string: 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.
    • body TargetTcpProxiesSetProxyHeaderRequest
    • 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.urlMaps.list

Retrieves the list of UrlMap resources available to the specified project.

google_compute.compute.urlMaps.list({
  "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 <.
    • 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.urlMaps.insert

Creates a UrlMap resource in the specified project using the data included in the request.

google_compute.compute.urlMaps.insert({
  "project": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body UrlMap
    • 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.urlMaps.delete

Deletes the specified UrlMap resource.

google_compute.compute.urlMaps.delete({
  "project": "",
  "urlMap": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap resource to delete.
    • requestId string: 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.
    • 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.urlMaps.get

Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap resource to return.
    • 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.urlMaps.patch

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

google_compute.compute.urlMaps.patch({
  "project": "",
  "urlMap": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap resource to patch.
    • requestId string: 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.
    • body UrlMap
    • 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.urlMaps.update

Updates the specified UrlMap resource with the data included in the request.

google_compute.compute.urlMaps.update({
  "project": "",
  "urlMap": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap resource to update.
    • requestId string: 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.
    • body UrlMap
    • 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.urlMaps.invalidateCache

Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.

For more information, see Invalidating cached content.

google_compute.compute.urlMaps.invalidateCache({
  "project": "",
  "urlMap": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap scoping this request.
    • requestId string: 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.
    • body CacheInvalidationRule
    • 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.urlMaps.validate

Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap.

google_compute.compute.urlMaps.validate({
  "project": "",
  "urlMap": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • urlMap required string: Name of the UrlMap resource to be validated as.
    • body UrlMapsValidateRequest
    • 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.listXpnHosts

Lists all shared VPC host projects visible to the user in an organization.

google_compute.compute.projects.listXpnHosts({
  "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 <.
    • 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.
    • body ProjectsListXpnHostsRequest
    • 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.moveDisk

Moves a persistent disk from one zone to another.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body DiskMoveRequest
    • 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.moveInstance

Moves an instance and its attached persistent disks from one zone to another.

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

Input

  • input object
    • project required string: Project ID for this request.
    • requestId string: 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.
    • body InstanceMoveRequest
    • 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.regions.list

Retrieves the list of region resources available to the specified project.

google_compute.compute.regions.list({
  "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 <.
    • 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.regions.get

Returns the specified Region resource. Gets a list of available regions by making a list() request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region resource to return.
    • 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.list

Retrieves a list of addresses contained within the specified region.

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

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region 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 <.
    • 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.insert

Creates an address resource in the specified project by using the data included in the request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region for this request.
    • requestId string: 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.
    • body Address
    • 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.delete

Deletes the specified address resource.

google_compute.compute.addresses.delete({
  "project": "",
  "region": "",
  "address": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region for this request.
    • address required string: Name of the address resource to delete.
    • requestId string: 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.
    • 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.get

Returns the specified address resource.

google_compute.compute.addresses.get({
  "project": "",
  "region": "",
  "address": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region for this request.
    • address required string: Name of the address resource to return.
    • 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.regionAutoscalers.list

Retrieves a list of autoscalers contained within the specified region.

google_compute.compute.regionAutoscalers.list({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region 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 <.
    • 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.regionAutoscalers.patch

Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

google_compute.compute.regionAutoscalers.patch({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • autoscaler string: Name of the autoscaler to patch.
    • requestId string: 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.
    • body Autoscaler
    • 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.regionAutoscalers.insert

Creates an autoscaler in the specified project using the data included in the request.

google_compute.compute.regionAutoscalers.insert({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • requestId string: 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.
    • body Autoscaler
    • 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.regionAutoscalers.update

Updates an autoscaler in the specified project using the data included in the request.

google_compute.compute.regionAutoscalers.update({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • autoscaler string: Name of the autoscaler to update.
    • requestId string: 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.
    • body Autoscaler
    • 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.regionAutoscalers.delete

Deletes the specified autoscaler.

google_compute.compute.regionAutoscalers.delete({
  "project": "",
  "region": "",
  "autoscaler": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • autoscaler required string: Name of the autoscaler to delete.
    • requestId string: 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.
    • 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.regionAutoscalers.get

Returns the specified autoscaler.

google_compute.compute.regionAutoscalers.get({
  "project": "",
  "region": "",
  "autoscaler": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • autoscaler required string: Name of the autoscaler to return.
    • 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.regionBackendServices.list

Retrieves the list of regional BackendService resources available to the specified project in the given region.

google_compute.compute.regionBackendServices.list({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region 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 <.
    • 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.regionBackendServices.insert

Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview.

google_compute.compute.regionBackendServices.insert({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • requestId string: 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.
    • body BackendService
    • 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.regionBackendServices.delete

Deletes the specified regional BackendService resource.

google_compute.compute.regionBackendServices.delete({
  "project": "",
  "region": "",
  "backendService": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • backendService required string: Name of the BackendService resource to delete.
    • requestId string: 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.
    • 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.regionBackendServices.get

Returns the specified regional BackendService resource.

google_compute.compute.regionBackendServices.get({
  "project": "",
  "region": "",
  "backendService": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • backendService required string: Name of the BackendService resource to return.
    • 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.regionBackendServices.patch

Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

google_compute.compute.regionBackendServices.patch({
  "project": "",
  "region": "",
  "backendService": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • backendService required string: Name of the BackendService resource to patch.
    • requestId string: 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.
    • body BackendService
    • 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.regionBackendServices.update

Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview.

google_compute.compute.regionBackendServices.update({
  "project": "",
  "region": "",
  "backendService": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region scoping this request.
    • backendService required string: Name of the BackendService resource to update.
    • requestId string: 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.
    • body BackendService
    • 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.regionBackendServices.getHealth

Gets the most recent health check results for this regional BackendService.

google_compute.compute.regionBackendServices.getHealth({
  "project": "",
  "region": "",
  "backendService": ""
}, context)

Input

  • input object
    • project required string
    • region required string: Name of the region scoping this request.
    • backendService required string: Name of the BackendService resource for which to get health.
    • body ResourceGroupReference
    • 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.list

Retrieves a list of commitments contained within the specified region.

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

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region 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 <.
    • 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.insert

Creates a commitment in the specified project using the data included in the request.

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

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region for this request.
    • requestId string: 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.
    • body Commitment
    • 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.get

Returns the specified commitment resource. Gets a list of available commitments by making a list() request.

google_compute.compute.regionCommitments.get({
  "project": "",
  "region": "",
  "commitment": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region for this request.
    • commitment required string: Name of the commitment to return.
    • 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.regionDiskTypes.list

Retrieves a list of regional disk types available to the specified project.

google_compute.compute.regionDiskTypes.list({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: The name of the region 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 <.
    • 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.regionDiskTypes.get

Returns the specified regional disk type. Gets a list of available disk types by making a list() request.

google_compute.compute.regionDiskTypes.get({
  "project": "",
  "region": "",
  "diskType": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: The name of the region for this request.
    • diskType required string: Name of the disk type to return.
    • 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.regionDisks.list

Retrieves the list of persistent disks contained within the specified region.

google_compute.compute.regionDisks.list({
  "project": "",
  "region": ""
}, context)

Input

  • input object
    • project required string: Project ID for this request.
    • region required string: Name of the region 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 compar

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/google_compute

Weekly Downloads

1

Version

6.0.0

License

MIT

Unpacked Size

4.89 MB

Total Files

4

Last publish

Collaborators

  • datafire