Google Git
Sign in
code / google-api-go-client / 7c0994ebca7fbbc06ddfb19a468563437f8ec040 / . / compute / v1 / compute-api.json
blob: 4d0c2a8f807cfc3210ce881ba8906cef3bf45de5 [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/compute": {
"description": "View and manage your Google Compute Engine resources"
},
"https://www.googleapis.com/auth/compute.readonly": {
"description": "View your Google Compute Engine resources"
},
"https://www.googleapis.com/auth/devstorage.full_control": {
"description": "Manage your data and permissions in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_only": {
"description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
}
}
}
},
"basePath": "/compute/v1/projects/",
"baseUrl": "https://compute.googleapis.com/compute/v1/projects/",
"batchPath": "batch/compute/v1",
"description": "Creates and runs virtual machines on Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/compute/docs/reference/latest/",
"etag": "\"u9GIe6H63LSGq-9_t39K2Zx_EAc/PZk7-wpz6XHgQMe6JksWYBgwpSs\"",
"icons": {
"x16": "https://www.google.com/images/icons/product/compute_engine-16.png",
"x32": "https://www.google.com/images/icons/product/compute_engine-32.png"
},
"id": "compute:v1",
"kind": "discovery#restDescription",
"name": "compute",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"alt": {
"default": "json",
"description": "Data format for the response.",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "An opaque string that represents a user for quota purposes. Must not exceed 40 characters.",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Deprecated. Please use quotaUser instead.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"acceleratorTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of accelerator types.",
"httpMethod": "GET",
"id": "compute.acceleratorTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/acceleratorTypes",
"response": {
"$ref": "AcceleratorTypeAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"get": {
"description": "Returns the specified accelerator type.",
"httpMethod": "GET",
"id": "compute.acceleratorTypes.get",
"parameterOrder": [
"project",
"zone",
"acceleratorType"
],
"parameters": {
"acceleratorType": {
"description": "Name of the accelerator type to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/acceleratorTypes/{acceleratorType}",
"response": {
"$ref": "AcceleratorType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of accelerator types available to the specified project.",
"httpMethod": "GET",
"id": "compute.acceleratorTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/acceleratorTypes",
"response": {
"$ref": "AcceleratorTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"addresses": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of addresses.",
"httpMethod": "GET",
"id": "compute.addresses.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/addresses",
"response": {
"$ref": "AddressAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified address resource.",
"httpMethod": "DELETE",
"id": "compute.addresses.delete",
"parameterOrder": [
"project",
"region",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/addresses/{address}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified address resource.",
"httpMethod": "GET",
"id": "compute.addresses.get",
"parameterOrder": [
"project",
"region",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/addresses/{address}",
"response": {
"$ref": "Address"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an address resource in the specified project by using the data included in the request.",
"httpMethod": "POST",
"id": "compute.addresses.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/addresses",
"request": {
"$ref": "Address"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of addresses contained within the specified region.",
"httpMethod": "GET",
"id": "compute.addresses.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/addresses",
"response": {
"$ref": "AddressList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"autoscalers": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of autoscalers.",
"httpMethod": "GET",
"id": "compute.autoscalers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/autoscalers",
"response": {
"$ref": "AutoscalerAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified autoscaler.",
"httpMethod": "DELETE",
"id": "compute.autoscalers.delete",
"parameterOrder": [
"project",
"zone",
"autoscaler"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request.",
"httpMethod": "GET",
"id": "compute.autoscalers.get",
"parameterOrder": [
"project",
"zone",
"autoscaler"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers/{autoscaler}",
"response": {
"$ref": "Autoscaler"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an autoscaler in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.autoscalers.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of autoscalers contained within the specified zone.",
"httpMethod": "GET",
"id": "compute.autoscalers.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers",
"response": {
"$ref": "AutoscalerList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.autoscalers.patch",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to patch.",
"location": "query",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates an autoscaler in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.autoscalers.update",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to update.",
"location": "query",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"backendBuckets": {
"methods": {
"addSignedUrlKey": {
"description": "Adds a key for validating requests with signed URLs for this backend bucket.",
"httpMethod": "POST",
"id": "compute.backendBuckets.addSignedUrlKey",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
"request": {
"$ref": "SignedUrlKey"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified BackendBucket resource.",
"httpMethod": "DELETE",
"id": "compute.backendBuckets.delete",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteSignedUrlKey": {
"description": "Deletes a key for validating requests with signed URLs for this backend bucket.",
"httpMethod": "POST",
"id": "compute.backendBuckets.deleteSignedUrlKey",
"parameterOrder": [
"project",
"backendBucket",
"keyName"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"keyName": {
"description": "The name of the Signed URL Key to delete.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request.",
"httpMethod": "GET",
"id": "compute.backendBuckets.get",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}",
"response": {
"$ref": "BackendBucket"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a BackendBucket resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.backendBuckets.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets",
"request": {
"$ref": "BackendBucket"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of BackendBucket resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.backendBuckets.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/backendBuckets",
"response": {
"$ref": "BackendBucketList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.backendBuckets.patch",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}",
"request": {
"$ref": "BackendBucket"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates the specified BackendBucket resource with the data included in the request.",
"httpMethod": "PUT",
"id": "compute.backendBuckets.update",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendBuckets/{backendBucket}",
"request": {
"$ref": "BackendBucket"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"backendServices": {
"methods": {
"addSignedUrlKey": {
"description": "Adds a key for validating requests with signed URLs for this backend service.",
"httpMethod": "POST",
"id": "compute.backendServices.addSignedUrlKey",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}/addSignedUrlKey",
"request": {
"$ref": "SignedUrlKey"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves the list of all BackendService resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.backendServices.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/backendServices",
"response": {
"$ref": "BackendServiceAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified BackendService resource.",
"httpMethod": "DELETE",
"id": "compute.backendServices.delete",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteSignedUrlKey": {
"description": "Deletes a key for validating requests with signed URLs for this backend service.",
"httpMethod": "POST",
"id": "compute.backendServices.deleteSignedUrlKey",
"parameterOrder": [
"project",
"backendService",
"keyName"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the Signed URL Key should be added. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"keyName": {
"description": "The name of the Signed URL Key to delete.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}/deleteSignedUrlKey",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified BackendService resource. Gets a list of available backend services.",
"httpMethod": "GET",
"id": "compute.backendServices.get",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}",
"response": {
"$ref": "BackendService"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getHealth": {
"description": "Gets the most recent health check results for this BackendService.\n\nExample request body:\n\n{ \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\" }",
"httpMethod": "POST",
"id": "compute.backendServices.getHealth",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the queried instance belongs.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}/getHealth",
"request": {
"$ref": "ResourceGroupReference"
},
"response": {
"$ref": "BackendServiceGroupHealth"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a backend service. Read Understanding backend services for more information.",
"httpMethod": "POST",
"id": "compute.backendServices.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of BackendService resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.backendServices.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/backendServices",
"response": {
"$ref": "BackendServiceList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.backendServices.patch",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSecurityPolicy": {
"description": "Sets the security policy for the specified backend service.",
"httpMethod": "POST",
"id": "compute.backendServices.setSecurityPolicy",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}/setSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates the specified BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information.",
"httpMethod": "PUT",
"id": "compute.backendServices.update",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"diskTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of disk types.",
"httpMethod": "GET",
"id": "compute.diskTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/diskTypes",
"response": {
"$ref": "DiskTypeAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"get": {
"description": "Returns the specified disk type. Gets a list of available disk types by making a list() request.",
"httpMethod": "GET",
"id": "compute.diskTypes.get",
"parameterOrder": [
"project",
"zone",
"diskType"
],
"parameters": {
"diskType": {
"description": "Name of the disk type to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/diskTypes/{diskType}",
"response": {
"$ref": "DiskType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of disk types available to the specified project.",
"httpMethod": "GET",
"id": "compute.diskTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/diskTypes",
"response": {
"$ref": "DiskTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"disks": {
"methods": {
"addResourcePolicies": {
"description": "Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.",
"httpMethod": "POST",
"id": "compute.disks.addResourcePolicies",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "The disk name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}/addResourcePolicies",
"request": {
"$ref": "DisksAddResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves an aggregated list of persistent disks.",
"httpMethod": "GET",
"id": "compute.disks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/disks",
"response": {
"$ref": "DiskAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"createSnapshot": {
"description": "Creates a snapshot of a specified persistent disk.",
"httpMethod": "POST",
"id": "compute.disks.createSnapshot",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the persistent disk to snapshot.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"guestFlush": {
"description": "[Input Only] Specifies to create an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).",
"location": "query",
"type": "boolean"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}/createSnapshot",
"request": {
"$ref": "Snapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
"httpMethod": "DELETE",
"id": "compute.disks.delete",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the persistent disk to delete.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request.",
"httpMethod": "GET",
"id": "compute.disks.get",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the persistent disk to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}",
"response": {
"$ref": "Disk"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.disks.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.",
"httpMethod": "POST",
"id": "compute.disks.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceImage": {
"description": "Optional. Source image to restore onto a disk.",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks",
"request": {
"$ref": "Disk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of persistent disks contained within the specified zone.",
"httpMethod": "GET",
"id": "compute.disks.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks",
"response": {
"$ref": "DiskList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"removeResourcePolicies": {
"description": "Removes resource policies from a disk.",
"httpMethod": "POST",
"id": "compute.disks.removeResourcePolicies",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "The disk name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
"request": {
"$ref": "DisksRemoveResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"description": "Resizes the specified persistent disk. You can only increase the size of the disk.",
"httpMethod": "POST",
"id": "compute.disks.resize",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "The name of the persistent disk.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{disk}/resize",
"request": {
"$ref": "DisksResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.disks.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.disks.setLabels",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{resource}/setLabels",
"request": {
"$ref": "ZoneSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.disks.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/disks/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"externalVpnGateways": {
"methods": {
"delete": {
"description": "Deletes the specified externalVpnGateway.",
"httpMethod": "DELETE",
"id": "compute.externalVpnGateways.delete",
"parameterOrder": [
"project",
"externalVpnGateway"
],
"parameters": {
"externalVpnGateway": {
"description": "Name of the externalVpnGateways to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways/{externalVpnGateway}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request.",
"httpMethod": "GET",
"id": "compute.externalVpnGateways.get",
"parameterOrder": [
"project",
"externalVpnGateway"
],
"parameters": {
"externalVpnGateway": {
"description": "Name of the externalVpnGateway to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways/{externalVpnGateway}",
"response": {
"$ref": "ExternalVpnGateway"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a ExternalVpnGateway in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.externalVpnGateways.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways",
"request": {
"$ref": "ExternalVpnGateway"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of ExternalVpnGateway available to the specified project.",
"httpMethod": "GET",
"id": "compute.externalVpnGateways.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways",
"response": {
"$ref": "ExternalVpnGatewayList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setLabels": {
"description": "Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.externalVpnGateways.setLabels",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.externalVpnGateways.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/externalVpnGateways/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"firewalls": {
"methods": {
"delete": {
"description": "Deletes the specified firewall.",
"httpMethod": "DELETE",
"id": "compute.firewalls.delete",
"parameterOrder": [
"project",
"firewall"
],
"parameters": {
"firewall": {
"description": "Name of the firewall rule to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/firewalls/{firewall}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified firewall.",
"httpMethod": "GET",
"id": "compute.firewalls.get",
"parameterOrder": [
"project",
"firewall"
],
"parameters": {
"firewall": {
"description": "Name of the firewall rule to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/firewalls/{firewall}",
"response": {
"$ref": "Firewall"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a firewall rule in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.firewalls.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/firewalls",
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of firewall rules available to the specified project.",
"httpMethod": "GET",
"id": "compute.firewalls.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/firewalls",
"response": {
"$ref": "FirewallList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.firewalls.patch",
"parameterOrder": [
"project",
"firewall"
],
"parameters": {
"firewall": {
"description": "Name of the firewall rule to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/firewalls/{firewall}",
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "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.",
"httpMethod": "PUT",
"id": "compute.firewalls.update",
"parameterOrder": [
"project",
"firewall"
],
"parameters": {
"firewall": {
"description": "Name of the firewall rule to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/firewalls/{firewall}",
"request": {
"$ref": "Firewall"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"forwardingRules": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of forwarding rules.",
"httpMethod": "GET",
"id": "compute.forwardingRules.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/forwardingRules",
"response": {
"$ref": "ForwardingRuleAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified ForwardingRule resource.",
"httpMethod": "DELETE",
"id": "compute.forwardingRules.delete",
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified ForwardingRule resource.",
"httpMethod": "GET",
"id": "compute.forwardingRules.get",
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
"response": {
"$ref": "ForwardingRule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a ForwardingRule resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.forwardingRules.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules",
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of ForwardingRule resources available to the specified project and region.",
"httpMethod": "GET",
"id": "compute.forwardingRules.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules",
"response": {
"$ref": "ForwardingRuleList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.forwardingRules.patch",
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}",
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTarget": {
"description": "Changes target URL for forwarding rule. The new target should be of the same type as the old target.",
"httpMethod": "POST",
"id": "compute.forwardingRules.setTarget",
"parameterOrder": [
"project",
"region",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource in which target is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"globalAddresses": {
"methods": {
"delete": {
"description": "Deletes the specified address resource.",
"httpMethod": "DELETE",
"id": "compute.globalAddresses.delete",
"parameterOrder": [
"project",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/addresses/{address}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified address resource. Gets a list of available addresses by making a list() request.",
"httpMethod": "GET",
"id": "compute.globalAddresses.get",
"parameterOrder": [
"project",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/addresses/{address}",
"response": {
"$ref": "Address"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an address resource in the specified project by using the data included in the request.",
"httpMethod": "POST",
"id": "compute.globalAddresses.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/addresses",
"request": {
"$ref": "Address"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of global addresses.",
"httpMethod": "GET",
"id": "compute.globalAddresses.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/addresses",
"response": {
"$ref": "AddressList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"globalForwardingRules": {
"methods": {
"delete": {
"description": "Deletes the specified GlobalForwardingRule resource.",
"httpMethod": "DELETE",
"id": "compute.globalForwardingRules.delete",
"parameterOrder": [
"project",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/forwardingRules/{forwardingRule}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.",
"httpMethod": "GET",
"id": "compute.globalForwardingRules.get",
"parameterOrder": [
"project",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/forwardingRules/{forwardingRule}",
"response": {
"$ref": "ForwardingRule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a GlobalForwardingRule resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.globalForwardingRules.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/forwardingRules",
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of GlobalForwardingRule resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.globalForwardingRules.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/forwardingRules",
"response": {
"$ref": "ForwardingRuleList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.globalForwardingRules.patch",
"parameterOrder": [
"project",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/forwardingRules/{forwardingRule}",
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTarget": {
"description": "Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.",
"httpMethod": "POST",
"id": "compute.globalForwardingRules.setTarget",
"parameterOrder": [
"project",
"forwardingRule"
],
"parameters": {
"forwardingRule": {
"description": "Name of the ForwardingRule resource in which target is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/forwardingRules/{forwardingRule}/setTarget",
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"globalNetworkEndpointGroups": {
"methods": {
"attachNetworkEndpoints": {
"description": "Attach a network endpoint to the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"request": {
"$ref": "GlobalNetworkEndpointGroupsAttachEndpointsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.",
"httpMethod": "DELETE",
"id": "compute.globalNetworkEndpointGroups.delete",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"detachNetworkEndpoints": {
"description": "Detach the network endpoint from the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"request": {
"$ref": "GlobalNetworkEndpointGroupsDetachEndpointsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
"httpMethod": "GET",
"id": "compute.globalNetworkEndpointGroups.get",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}",
"response": {
"$ref": "NetworkEndpointGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups",
"request": {
"$ref": "NetworkEndpointGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of network endpoint groups that are located in the specified project.",
"httpMethod": "GET",
"id": "compute.globalNetworkEndpointGroups.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups",
"response": {
"$ref": "NetworkEndpointGroupList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listNetworkEndpoints": {
"description": "Lists the network endpoints in the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"networkEndpointGroup": {
"description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"response": {
"$ref": "NetworkEndpointGroupsListNetworkEndpoints"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"globalOperations": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of all operations.",
"httpMethod": "GET",
"id": "compute.globalOperations.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/operations",
"response": {
"$ref": "OperationAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified Operations resource.",
"httpMethod": "DELETE",
"id": "compute.globalOperations.delete",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/operations/{operation}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request.",
"httpMethod": "GET",
"id": "compute.globalOperations.get",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/operations/{operation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of Operation resources contained within the specified project.",
"httpMethod": "GET",
"id": "compute.globalOperations.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/operations",
"response": {
"$ref": "OperationList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"wait": {
"description": "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.\n\nThis method is called on a best-effort basis. Specifically: \n- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. \n- 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`.",
"httpMethod": "POST",
"id": "compute.globalOperations.wait",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/operations/{operation}/wait",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"healthChecks": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all HealthCheck resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.healthChecks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/healthChecks",
"response": {
"$ref": "HealthChecksAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified HealthCheck resource.",
"httpMethod": "DELETE",
"id": "compute.healthChecks.delete",
"parameterOrder": [
"project",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/healthChecks/{healthCheck}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
"httpMethod": "GET",
"id": "compute.healthChecks.get",
"parameterOrder": [
"project",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/healthChecks/{healthCheck}",
"response": {
"$ref": "HealthCheck"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.healthChecks.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/healthChecks",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of HealthCheck resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.healthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/healthChecks",
"response": {
"$ref": "HealthCheckList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.healthChecks.patch",
"parameterOrder": [
"project",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/healthChecks/{healthCheck}",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.healthChecks.update",
"parameterOrder": [
"project",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/healthChecks/{healthCheck}",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"httpHealthChecks": {
"methods": {
"delete": {
"description": "Deletes the specified HttpHealthCheck resource.",
"httpMethod": "DELETE",
"id": "compute.httpHealthChecks.delete",
"parameterOrder": [
"project",
"httpHealthCheck"
],
"parameters": {
"httpHealthCheck": {
"description": "Name of the HttpHealthCheck resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request.",
"httpMethod": "GET",
"id": "compute.httpHealthChecks.get",
"parameterOrder": [
"project",
"httpHealthCheck"
],
"parameters": {
"httpHealthCheck": {
"description": "Name of the HttpHealthCheck resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"response": {
"$ref": "HttpHealthCheck"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a HttpHealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.httpHealthChecks.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks",
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of HttpHealthCheck resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.httpHealthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks",
"response": {
"$ref": "HttpHealthCheckList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.httpHealthChecks.patch",
"parameterOrder": [
"project",
"httpHealthCheck"
],
"parameters": {
"httpHealthCheck": {
"description": "Name of the HttpHealthCheck resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates a HttpHealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.httpHealthChecks.update",
"parameterOrder": [
"project",
"httpHealthCheck"
],
"parameters": {
"httpHealthCheck": {
"description": "Name of the HttpHealthCheck resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpHealthChecks/{httpHealthCheck}",
"request": {
"$ref": "HttpHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"httpsHealthChecks": {
"methods": {
"delete": {
"description": "Deletes the specified HttpsHealthCheck resource.",
"httpMethod": "DELETE",
"id": "compute.httpsHealthChecks.delete",
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"parameters": {
"httpsHealthCheck": {
"description": "Name of the HttpsHealthCheck resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request.",
"httpMethod": "GET",
"id": "compute.httpsHealthChecks.get",
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"parameters": {
"httpsHealthCheck": {
"description": "Name of the HttpsHealthCheck resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"response": {
"$ref": "HttpsHealthCheck"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a HttpsHealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.httpsHealthChecks.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks",
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of HttpsHealthCheck resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.httpsHealthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks",
"response": {
"$ref": "HttpsHealthCheckList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.httpsHealthChecks.patch",
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"parameters": {
"httpsHealthCheck": {
"description": "Name of the HttpsHealthCheck resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates a HttpsHealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.httpsHealthChecks.update",
"parameterOrder": [
"project",
"httpsHealthCheck"
],
"parameters": {
"httpsHealthCheck": {
"description": "Name of the HttpsHealthCheck resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"images": {
"methods": {
"delete": {
"description": "Deletes the specified image.",
"httpMethod": "DELETE",
"id": "compute.images.delete",
"parameterOrder": [
"project",
"image"
],
"parameters": {
"image": {
"description": "Name of the image resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/images/{image}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deprecate": {
"description": "Sets the deprecation status of an image.\n\nIf an empty request body is given, clears the deprecation status instead.",
"httpMethod": "POST",
"id": "compute.images.deprecate",
"parameterOrder": [
"project",
"image"
],
"parameters": {
"image": {
"description": "Image name.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/images/{image}/deprecate",
"request": {
"$ref": "DeprecationStatus"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified image. Gets a list of available images by making a list() request.",
"httpMethod": "GET",
"id": "compute.images.get",
"parameterOrder": [
"project",
"image"
],
"parameters": {
"image": {
"description": "Name of the image resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/{image}",
"response": {
"$ref": "Image"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getFromFamily": {
"description": "Returns the latest image that is part of an image family and is not deprecated.",
"httpMethod": "GET",
"id": "compute.images.getFromFamily",
"parameterOrder": [
"project",
"family"
],
"parameters": {
"family": {
"description": "Name of the image family to search for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/family/{family}",
"response": {
"$ref": "Image"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.images.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an image in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.images.insert",
"parameterOrder": [
"project"
],
"parameters": {
"forceCreate": {
"description": "Force image creation if true.",
"location": "query",
"type": "boolean"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/images",
"request": {
"$ref": "Image"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"list": {
"description": "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.",
"httpMethod": "GET",
"id": "compute.images.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images",
"response": {
"$ref": "ImageList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.images.setIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.images.setLabels",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.images.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/images/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"instanceGroupManagers": {
"methods": {
"abandonInstances": {
"description": "Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.abandonInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"request": {
"$ref": "InstanceGroupManagersAbandonInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves the list of managed instance groups and groups them by zone.",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/instanceGroupManagers",
"response": {
"$ref": "InstanceGroupManagerAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"applyUpdatesToInstances": {
"description": "Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.applyUpdatesToInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group, should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located. Should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
"request": {
"$ref": "InstanceGroupManagersApplyUpdatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"createInstances": {
"description": "Creates instances with per-instance configs in this managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.createInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
"request": {
"$ref": "InstanceGroupManagersCreateInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information.",
"httpMethod": "DELETE",
"id": "compute.instanceGroupManagers.delete",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group to delete.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteInstances": {
"description": "Flags the specified instances in the managed instance group for immediate deletion. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. This operation is marked as DONE when the action is scheduled even if the instances are still being deleted. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.deleteInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"request": {
"$ref": "InstanceGroupManagersDeleteInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request.",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.get",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"response": {
"$ref": "InstanceGroupManager"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where you want to create the managed instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers",
"request": {
"$ref": "InstanceGroupManager"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of managed instance groups that are contained within the specified project and zone.",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers",
"response": {
"$ref": "InstanceGroupManagerList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listErrors": {
"description": "Lists all errors thrown by actions on instances for a given managed instance group.",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.listErrors",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
"response": {
"$ref": "InstanceGroupManagersListErrorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listManagedInstances": {
"description": "Lists all of the instances in the managed instance group. Each instance in the list has a currentAction, which indicates the action that the managed instance group is performing on the instance. For example, if the group is still creating an instance, the currentAction is CREATING. If a previous action failed, the list displays the errors for that failed action.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.listManagedInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
"response": {
"$ref": "InstanceGroupManagersListManagedInstancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.instanceGroupManagers.patch",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the instance group manager.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where you want to create the managed instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"request": {
"$ref": "InstanceGroupManager"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"recreateInstances": {
"description": "Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.recreateInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"request": {
"$ref": "InstanceGroupManagersRecreateInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"description": "Resizes the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes instances. The resize operation is marked DONE when the resize actions are scheduled even if the group has not yet added or deleted any instances. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nWhen resizing down, the instance group arbitrarily chooses the order in which VMs are deleted. The group takes into account some VM attributes when making the selection including:\n\n+ The status of the VM instance. + The health of the VM instance. + The instance template version the VM is based on. + For regional managed instance groups, the location of the VM instance.\n\nThis list is subject to change.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.resize",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager",
"size"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"size": {
"description": "The number of running instances that the managed instance group should maintain at any given time. The group automatically adds or removes instances to maintain the number of instances specified by this parameter.",
"format": "int32",
"location": "query",
"required": true,
"type": "integer"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setInstanceTemplate": {
"description": "Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you recreate them.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.setInstanceTemplate",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
"request": {
"$ref": "InstanceGroupManagersSetInstanceTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTargetPools": {
"description": "Modifies the target pools to which all instances in this managed instance group are assigned. The target pools automatically apply to all of the instances in the managed instance group. This operation is marked DONE when you make the request even if the instances have not yet been added to their target pools. The change might take some time to apply to all of the instances in the group depending on the size of the group.",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.setTargetPools",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the managed instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
"request": {
"$ref": "InstanceGroupManagersSetTargetPoolsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"instanceGroups": {
"methods": {
"addInstances": {
"description": "Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.",
"httpMethod": "POST",
"id": "compute.instanceGroups.addInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the instance group where you are adding instances.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
"request": {
"$ref": "InstanceGroupsAddInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves the list of instance groups and sorts them by zone.",
"httpMethod": "GET",
"id": "compute.instanceGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/instanceGroups",
"response": {
"$ref": "InstanceGroupAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.",
"httpMethod": "DELETE",
"id": "compute.instanceGroups.delete",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the instance group to delete.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified instance group. Gets a list of available instance groups by making a list() request.",
"httpMethod": "GET",
"id": "compute.instanceGroups.get",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"response": {
"$ref": "InstanceGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an instance group in the specified project using the parameters that are included in the request.",
"httpMethod": "POST",
"id": "compute.instanceGroups.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where you want to create the instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups",
"request": {
"$ref": "InstanceGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of instance groups that are located in the specified project and zone.",
"httpMethod": "GET",
"id": "compute.instanceGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups",
"response": {
"$ref": "InstanceGroupList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listInstances": {
"description": "Lists the instances in the specified instance group.",
"httpMethod": "POST",
"id": "compute.instanceGroups.listInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroup": {
"description": "The name of the instance group from which you want to generate a list of included instances.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
"request": {
"$ref": "InstanceGroupsListInstancesRequest"
},
"response": {
"$ref": "InstanceGroupsListInstances"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"removeInstances": {
"description": "Removes one or more instances from the specified instance group, but does not delete those instances.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.",
"httpMethod": "POST",
"id": "compute.instanceGroups.removeInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the instance group where the specified instances will be removed.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"request": {
"$ref": "InstanceGroupsRemoveInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setNamedPorts": {
"description": "Sets the named ports for the specified instance group.",
"httpMethod": "POST",
"id": "compute.instanceGroups.setNamedPorts",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the instance group where the named ports are updated.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
"request": {
"$ref": "InstanceGroupsSetNamedPortsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"instanceTemplates": {
"methods": {
"delete": {
"description": "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.",
"httpMethod": "DELETE",
"id": "compute.instanceTemplates.delete",
"parameterOrder": [
"project",
"instanceTemplate"
],
"parameters": {
"instanceTemplate": {
"description": "The name of the instance template to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/instanceTemplates/{instanceTemplate}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified instance template. Gets a list of available instance templates by making a list() request.",
"httpMethod": "GET",
"id": "compute.instanceTemplates.get",
"parameterOrder": [
"project",
"instanceTemplate"
],
"parameters": {
"instanceTemplate": {
"description": "The name of the instance template.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/instanceTemplates/{instanceTemplate}",
"response": {
"$ref": "InstanceTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.instanceTemplates.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/instanceTemplates/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.instanceTemplates.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/instanceTemplates",
"request": {
"$ref": "InstanceTemplate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of instance templates that are contained within the specified project.",
"httpMethod": "GET",
"id": "compute.instanceTemplates.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/instanceTemplates",
"response": {
"$ref": "InstanceTemplateList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.instanceTemplates.setIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/instanceTemplates/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.instanceTemplates.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/instanceTemplates/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"instances": {
"methods": {
"addAccessConfig": {
"description": "Adds an access config to an instance's network interface.",
"httpMethod": "POST",
"id": "compute.instances.addAccessConfig",
"parameterOrder": [
"project",
"zone",
"instance",
"networkInterface"
],
"parameters": {
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"networkInterface": {
"description": "The name of the network interface to add to this instance.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/addAccessConfig",
"request": {
"$ref": "AccessConfig"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addResourcePolicies": {
"description": "Adds existing resource policies to an instance. You can only add one policy right now which will be applied to this instance for scheduling live migrations.",
"httpMethod": "POST",
"id": "compute.instances.addResourcePolicies",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
"request": {
"$ref": "InstancesAddResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves aggregated list of all of the instances in your project across all regions and zones.",
"httpMethod": "GET",
"id": "compute.instances.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/instances",
"response": {
"$ref": "InstanceAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"attachDisk": {
"description": "Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance.",
"httpMethod": "POST",
"id": "compute.instances.attachDisk",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"forceAttach": {
"description": "Whether to force attach the disk even if it's currently attached to another instance.",
"location": "query",
"type": "boolean"
},
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/attachDisk",
"request": {
"$ref": "AttachedDisk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance.",
"httpMethod": "DELETE",
"id": "compute.instances.delete",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteAccessConfig": {
"description": "Deletes an access config from an instance's network interface.",
"httpMethod": "POST",
"id": "compute.instances.deleteAccessConfig",
"parameterOrder": [
"project",
"zone",
"instance",
"accessConfig",
"networkInterface"
],
"parameters": {
"accessConfig": {
"description": "The name of the access config to delete.",
"location": "query",
"required": true,
"type": "string"
},
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"networkInterface": {
"description": "The name of the network interface.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"detachDisk": {
"description": "Detaches a disk from an instance.",
"httpMethod": "POST",
"id": "compute.instances.detachDisk",
"parameterOrder": [
"project",
"zone",
"instance",
"deviceName"
],
"parameters": {
"deviceName": {
"description": "The device name of the disk to detach. Make a get() request on the instance to view currently attached disks and device names.",
"location": "query",
"required": true,
"type": "string"
},
"instance": {
"description": "Instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/detachDisk",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Instance resource. Gets a list of available instances by making a list() request.",
"httpMethod": "GET",
"id": "compute.instances.get",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}",
"response": {
"$ref": "Instance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getGuestAttributes": {
"description": "Returns the specified guest attributes entry.",
"httpMethod": "GET",
"id": "compute.instances.getGuestAttributes",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"queryPath": {
"description": "Specifies the guest attributes path to be queried.",
"location": "query",
"type": "string"
},
"variableKey": {
"description": "Specifies the key for the guest attributes entry.",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
"response": {
"$ref": "GuestAttributes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.instances.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getSerialPortOutput": {
"description": "Returns the last 1 MB of serial port output from the specified instance.",
"httpMethod": "GET",
"id": "compute.instances.getSerialPortOutput",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"port": {
"default": "1",
"description": "Specifies which COM or serial port to retrieve data from.",
"format": "int32",
"location": "query",
"maximum": "4",
"minimum": "1",
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"start": {
"description": "Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call.",
"format": "int64",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/serialPort",
"response": {
"$ref": "SerialPortOutput"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getShieldedInstanceIdentity": {
"description": "Returns the Shielded Instance Identity of an instance",
"httpMethod": "GET",
"id": "compute.instances.getShieldedInstanceIdentity",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name or id of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
"response": {
"$ref": "ShieldedInstanceIdentity"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an instance resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.instances.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceInstanceTemplate": {
"description": "Specifies instance template to create the instance.\n\nThis field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template: \n- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate \n- projects/project/global/instanceTemplates/instanceTemplate \n- global/instanceTemplates/instanceTemplate",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of instances contained within the specified zone.",
"httpMethod": "GET",
"id": "compute.instances.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances",
"response": {
"$ref": "InstanceList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listReferrers": {
"description": "Retrieves the list of referrers to instances contained within the specified zone. For more information, read Viewing Referrers to VM Instances.",
"httpMethod": "GET",
"id": "compute.instances.listReferrers",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instance": {
"description": "Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.",
"location": "path",
"pattern": "-|[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/referrers",
"response": {
"$ref": "InstanceListReferrers"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"removeResourcePolicies": {
"description": "Removes resource policies from an instance.",
"httpMethod": "POST",
"id": "compute.instances.removeResourcePolicies",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
"request": {
"$ref": "InstancesRemoveResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"reset": {
"description": "Performs a reset on the instance. This is a hard reset the VM does not do a graceful shutdown. For more information, see Resetting an instance.",
"httpMethod": "POST",
"id": "compute.instances.reset",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/reset",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setDeletionProtection": {
"description": "Sets deletion protection on the instance.",
"httpMethod": "POST",
"id": "compute.instances.setDeletionProtection",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"deletionProtection": {
"default": "true",
"description": "Whether the resource should be protected against deletion.",
"location": "query",
"type": "boolean"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setDiskAutoDelete": {
"description": "Sets the auto-delete flag for a disk attached to an instance.",
"httpMethod": "POST",
"id": "compute.instances.setDiskAutoDelete",
"parameterOrder": [
"project",
"zone",
"instance",
"autoDelete",
"deviceName"
],
"parameters": {
"autoDelete": {
"description": "Whether to auto-delete the disk when the instance is deleted.",
"location": "query",
"required": true,
"type": "boolean"
},
"deviceName": {
"description": "The device name of the disk to modify. Make a get() request on the instance to view currently attached disks and device names.",
"location": "query",
"pattern": "\\w[\\w.-]{0,254}",
"required": true,
"type": "string"
},
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.instances.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.instances.setLabels",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setLabels",
"request": {
"$ref": "InstancesSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMachineResources": {
"description": "Changes the number and/or type of accelerator for a stopped instance to the values specified in the request.",
"httpMethod": "POST",
"id": "compute.instances.setMachineResources",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setMachineResources",
"request": {
"$ref": "InstancesSetMachineResourcesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMachineType": {
"description": "Changes the machine type for a stopped instance to the machine type specified in the request.",
"httpMethod": "POST",
"id": "compute.instances.setMachineType",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setMachineType",
"request": {
"$ref": "InstancesSetMachineTypeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMetadata": {
"description": "Sets metadata for the specified instance to the data included in the request.",
"httpMethod": "POST",
"id": "compute.instances.setMetadata",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setMetadata",
"request": {
"$ref": "Metadata"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setMinCpuPlatform": {
"description": "Changes the minimum CPU platform that this instance should use. This method can only be called on a stopped instance. For more information, read Specifying a Minimum CPU Platform.",
"httpMethod": "POST",
"id": "compute.instances.setMinCpuPlatform",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
"request": {
"$ref": "InstancesSetMinCpuPlatformRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setScheduling": {
"description": "Sets an instance's scheduling options.",
"httpMethod": "POST",
"id": "compute.instances.setScheduling",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setScheduling",
"request": {
"$ref": "Scheduling"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setServiceAccount": {
"description": "Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance.",
"httpMethod": "POST",
"id": "compute.instances.setServiceAccount",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to start.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setServiceAccount",
"request": {
"$ref": "InstancesSetServiceAccountRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setShieldedInstanceIntegrityPolicy": {
"description": "Sets the Shielded Instance integrity policy for an instance. You can only use this method on a running instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.instances.setShieldedInstanceIntegrityPolicy",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name or id of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
"request": {
"$ref": "ShieldedInstanceIntegrityPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTags": {
"description": "Sets network tags for the specified instance to the data included in the request.",
"httpMethod": "POST",
"id": "compute.instances.setTags",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/setTags",
"request": {
"$ref": "Tags"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"simulateMaintenanceEvent": {
"description": "Simulates a maintenance event on the instance.",
"httpMethod": "POST",
"id": "compute.instances.simulateMaintenanceEvent",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"start": {
"description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.",
"httpMethod": "POST",
"id": "compute.instances.start",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to start.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/start",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"startWithEncryptionKey": {
"description": "Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance.",
"httpMethod": "POST",
"id": "compute.instances.startWithEncryptionKey",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to start.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
"request": {
"$ref": "InstancesStartWithEncryptionKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stop": {
"description": "Stops a running instance, shutting it down cleanly, and allows you to restart the instance at a later time. Stopped instances do not incur VM usage charges while they are stopped. However, resources that the VM is using, such as persistent disks and static IP addresses, will continue to be charged until they are deleted. For more information, see Stopping an instance.",
"httpMethod": "POST",
"id": "compute.instances.stop",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to stop.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/stop",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.instances.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Updates an instance only if the necessary resources are available. This method can update only a specific set of instance properties. See Updating a running instance for a list of updatable instance properties.",
"httpMethod": "PUT",
"id": "compute.instances.update",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"minimalAction": {
"description": "Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require.",
"enum": [
"INVALID",
"NO_EFFECT",
"REFRESH",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "query",
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART.",
"enum": [
"INVALID",
"NO_EFFECT",
"REFRESH",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}",
"request": {
"$ref": "Instance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateAccessConfig": {
"description": "Updates the specified access config from an instance's network interface with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "POST",
"id": "compute.instances.updateAccessConfig",
"parameterOrder": [
"project",
"zone",
"instance",
"networkInterface"
],
"parameters": {
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"networkInterface": {
"description": "The name of the network interface where the access config is attached.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
"request": {
"$ref": "AccessConfig"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateDisplayDevice": {
"description": "Updates the Display config for a VM instance. You can only use this method on a stopped VM instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.instances.updateDisplayDevice",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
"request": {
"$ref": "DisplayDevice"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateNetworkInterface": {
"description": "Updates an instance's network interface. This method follows PATCH semantics.",
"httpMethod": "PATCH",
"id": "compute.instances.updateNetworkInterface",
"parameterOrder": [
"project",
"zone",
"instance",
"networkInterface"
],
"parameters": {
"instance": {
"description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"networkInterface": {
"description": "The name of the network interface to update.",
"location": "query",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
"request": {
"$ref": "NetworkInterface"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateShieldedInstanceConfig": {
"description": "Updates the Shielded Instance config for an instance. You can only use this method on a stopped instance. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.instances.updateShieldedInstanceConfig",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name or id of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
"request": {
"$ref": "ShieldedInstanceConfig"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"interconnectAttachments": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of interconnect attachments.",
"httpMethod": "GET",
"id": "compute.interconnectAttachments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/interconnectAttachments",
"response": {
"$ref": "InterconnectAttachmentAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified interconnect attachment.",
"httpMethod": "DELETE",
"id": "compute.interconnectAttachments.delete",
"parameterOrder": [
"project",
"region",
"interconnectAttachment"
],
"parameters": {
"interconnectAttachment": {
"description": "Name of the interconnect attachment to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified interconnect attachment.",
"httpMethod": "GET",
"id": "compute.interconnectAttachments.get",
"parameterOrder": [
"project",
"region",
"interconnectAttachment"
],
"parameters": {
"interconnectAttachment": {
"description": "Name of the interconnect attachment to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"response": {
"$ref": "InterconnectAttachment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an InterconnectAttachment in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.interconnectAttachments.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "{project}/regions/{region}/interconnectAttachments",
"request": {
"$ref": "InterconnectAttachment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of interconnect attachments contained within the specified region.",
"httpMethod": "GET",
"id": "compute.interconnectAttachments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/interconnectAttachments",
"response": {
"$ref": "InterconnectAttachmentList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.interconnectAttachments.patch",
"parameterOrder": [
"project",
"region",
"interconnectAttachment"
],
"parameters": {
"interconnectAttachment": {
"description": "Name of the interconnect attachment to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"request": {
"$ref": "InterconnectAttachment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"interconnectLocations": {
"methods": {
"get": {
"description": "Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.",
"httpMethod": "GET",
"id": "compute.interconnectLocations.get",
"parameterOrder": [
"project",
"interconnectLocation"
],
"parameters": {
"interconnectLocation": {
"description": "Name of the interconnect location to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/interconnectLocations/{interconnectLocation}",
"response": {
"$ref": "InterconnectLocation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves the list of interconnect locations available to the specified project.",
"httpMethod": "GET",
"id": "compute.interconnectLocations.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/interconnectLocations",
"response": {
"$ref": "InterconnectLocationList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"interconnects": {
"methods": {
"delete": {
"description": "Deletes the specified interconnect.",
"httpMethod": "DELETE",
"id": "compute.interconnects.delete",
"parameterOrder": [
"project",
"interconnect"
],
"parameters": {
"interconnect": {
"description": "Name of the interconnect to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/interconnects/{interconnect}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified interconnect. Get a list of available interconnects by making a list() request.",
"httpMethod": "GET",
"id": "compute.interconnects.get",
"parameterOrder": [
"project",
"interconnect"
],
"parameters": {
"interconnect": {
"description": "Name of the interconnect to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/interconnects/{interconnect}",
"response": {
"$ref": "Interconnect"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getDiagnostics": {
"description": "Returns the interconnectDiagnostics for the specified interconnect.",
"httpMethod": "GET",
"id": "compute.interconnects.getDiagnostics",
"parameterOrder": [
"project",
"interconnect"
],
"parameters": {
"interconnect": {
"description": "Name of the interconnect resource to query.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/interconnects/{interconnect}/getDiagnostics",
"response": {
"$ref": "InterconnectsGetDiagnosticsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a Interconnect in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.interconnects.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/interconnects",
"request": {
"$ref": "Interconnect"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of interconnect available to the specified project.",
"httpMethod": "GET",
"id": "compute.interconnects.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/interconnects",
"response": {
"$ref": "InterconnectList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.interconnects.patch",
"parameterOrder": [
"project",
"interconnect"
],
"parameters": {
"interconnect": {
"description": "Name of the interconnect to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/interconnects/{interconnect}",
"request": {
"$ref": "Interconnect"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"licenseCodes": {
"methods": {
"get": {
"description": "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.",
"httpMethod": "GET",
"id": "compute.licenseCodes.get",
"parameterOrder": [
"project",
"licenseCode"
],
"parameters": {
"licenseCode": {
"description": "Number corresponding to the License code resource to return.",
"location": "path",
"pattern": "[0-9]{0,61}?",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenseCodes/{licenseCode}",
"response": {
"$ref": "LicenseCode"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"testIamPermissions": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.licenseCodes.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenseCodes/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"licenses": {
"methods": {
"delete": {
"description": "Deletes the specified license. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.",
"httpMethod": "DELETE",
"id": "compute.licenses.delete",
"parameterOrder": [
"project",
"license"
],
"parameters": {
"license": {
"description": "Name of the license resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/licenses/{license}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified License resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.",
"httpMethod": "GET",
"id": "compute.licenses.get",
"parameterOrder": [
"project",
"license"
],
"parameters": {
"license": {
"description": "Name of the License resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenses/{license}",
"response": {
"$ref": "License"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "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.",
"httpMethod": "GET",
"id": "compute.licenses.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenses/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.licenses.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/licenses",
"request": {
"$ref": "License"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
},
"list": {
"description": "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.",
"httpMethod": "GET",
"id": "compute.licenses.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenses",
"response": {
"$ref": "LicensesListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.licenses.setIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenses/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.licenses.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/licenses/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"machineTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of machine types.",
"httpMethod": "GET",
"id": "compute.machineTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/machineTypes",
"response": {
"$ref": "MachineTypeAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"get": {
"description": "Returns the specified machine type. Gets a list of available machine types by making a list() request.",
"httpMethod": "GET",
"id": "compute.machineTypes.get",
"parameterOrder": [
"project",
"zone",
"machineType"
],
"parameters": {
"machineType": {
"description": "Name of the machine type to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/machineTypes/{machineType}",
"response": {
"$ref": "MachineType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of machine types available to the specified project.",
"httpMethod": "GET",
"id": "compute.machineTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/machineTypes",
"response": {
"$ref": "MachineTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"networkEndpointGroups": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of network endpoint groups and sorts them by zone.",
"httpMethod": "GET",
"id": "compute.networkEndpointGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/networkEndpointGroups",
"response": {
"$ref": "NetworkEndpointGroupAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"attachNetworkEndpoints": {
"description": "Attach a list of network endpoints to the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.attachNetworkEndpoints",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"request": {
"$ref": "NetworkEndpointGroupsAttachEndpointsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.",
"httpMethod": "DELETE",
"id": "compute.networkEndpointGroups.delete",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group to delete. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"detachNetworkEndpoints": {
"description": "Detach a list of network endpoints from the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.detachNetworkEndpoints",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"request": {
"$ref": "NetworkEndpointGroupsDetachEndpointsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.",
"httpMethod": "GET",
"id": "compute.networkEndpointGroups.get",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
"response": {
"$ref": "NetworkEndpointGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a network endpoint group in the specified project using the parameters that are included in the request.",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where you want to create the network endpoint group. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups",
"request": {
"$ref": "NetworkEndpointGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of network endpoint groups that are located in the specified project and zone.",
"httpMethod": "GET",
"id": "compute.networkEndpointGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups",
"response": {
"$ref": "NetworkEndpointGroupList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listNetworkEndpoints": {
"description": "Lists the network endpoints in the specified network endpoint group.",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.listNetworkEndpoints",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"networkEndpointGroup": {
"description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone where the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"request": {
"$ref": "NetworkEndpointGroupsListEndpointsRequest"
},
"response": {
"$ref": "NetworkEndpointGroupsListNetworkEndpoints"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"networks": {
"methods": {
"addPeering": {
"description": "Adds a peering to the specified network.",
"httpMethod": "POST",
"id": "compute.networks.addPeering",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network resource to add peering to.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}/addPeering",
"request": {
"$ref": "NetworksAddPeeringRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified network.",
"httpMethod": "DELETE",
"id": "compute.networks.delete",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified network. Gets a list of available networks by making a list() request.",
"httpMethod": "GET",
"id": "compute.networks.get",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/networks/{network}",
"response": {
"$ref": "Network"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a network in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.networks.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks",
"request": {
"$ref": "Network"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of networks available to the specified project.",
"httpMethod": "GET",
"id": "compute.networks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/networks",
"response": {
"$ref": "NetworkList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listPeeringRoutes": {
"description": "Lists the peering routes exchanged over peering connection.",
"httpMethod": "GET",
"id": "compute.networks.listPeeringRoutes",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"direction": {
"description": "The direction of the exchanged routes.",
"enum": [
"INCOMING",
"OUTGOING"
],
"enumDescriptions": [
"",
""
],
"location": "query",
"type": "string"
},
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"network": {
"description": "Name of the network for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"peeringName": {
"description": "The response will show routes exchanged over the given peering connection.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region.",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}/listPeeringRoutes",
"response": {
"$ref": "ExchangedPeeringRoutesList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.",
"httpMethod": "PATCH",
"id": "compute.networks.patch",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}",
"request": {
"$ref": "Network"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removePeering": {
"description": "Removes a peering from the specified network.",
"httpMethod": "POST",
"id": "compute.networks.removePeering",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network resource to remove peering from.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}/removePeering",
"request": {
"$ref": "NetworksRemovePeeringRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"switchToCustomMode": {
"description": "Switches the network mode from auto subnet mode to custom subnet mode.",
"httpMethod": "POST",
"id": "compute.networks.switchToCustomMode",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network to be updated.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}/switchToCustomMode",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updatePeering": {
"description": "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",
"httpMethod": "PATCH",
"id": "compute.networks.updatePeering",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"network": {
"description": "Name of the network resource which the updated peering is belonging to.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/networks/{network}/updatePeering",
"request": {
"$ref": "NetworksUpdatePeeringRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"nodeGroups": {
"methods": {
"addNodes": {
"description": "Adds specified number of nodes to the node group.",
"httpMethod": "POST",
"id": "compute.nodeGroups.addNodes",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
"request": {
"$ref": "NodeGroupsAddNodesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group.",
"httpMethod": "GET",
"id": "compute.nodeGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/nodeGroups",
"response": {
"$ref": "NodeGroupAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified NodeGroup resource.",
"httpMethod": "DELETE",
"id": "compute.nodeGroups.delete",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteNodes": {
"description": "Deletes specified nodes from the node group.",
"httpMethod": "POST",
"id": "compute.nodeGroups.deleteNodes",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource whose nodes will be deleted.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
"request": {
"$ref": "NodeGroupsDeleteNodesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the \"nodes\" field should not be used. Use nodeGroups.listNodes instead.",
"httpMethod": "GET",
"id": "compute.nodeGroups.get",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the node group to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"response": {
"$ref": "NodeGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.nodeGroups.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a NodeGroup resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.nodeGroups.insert",
"parameterOrder": [
"project",
"zone",
"initialNodeCount"
],
"parameters": {
"initialNodeCount": {
"description": "Initial count of nodes in the node group.",
"format": "int32",
"location": "query",
"required": true,
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups",
"request": {
"$ref": "NodeGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group.",
"httpMethod": "GET",
"id": "compute.nodeGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups",
"response": {
"$ref": "NodeGroupList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listNodes": {
"description": "Lists nodes in the node group.",
"httpMethod": "POST",
"id": "compute.nodeGroups.listNodes",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"nodeGroup": {
"description": "Name of the NodeGroup resource whose nodes you want to list.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
"response": {
"$ref": "NodeGroupsListNodes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Updates the specified node group.",
"httpMethod": "PATCH",
"id": "compute.nodeGroups.patch",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"request": {
"$ref": "NodeGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.nodeGroups.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setNodeTemplate": {
"description": "Updates the node template of the node group.",
"httpMethod": "POST",
"id": "compute.nodeGroups.setNodeTemplate",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
"request": {
"$ref": "NodeGroupsSetNodeTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.nodeGroups.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"nodeTemplates": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of node templates.",
"httpMethod": "GET",
"id": "compute.nodeTemplates.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/nodeTemplates",
"response": {
"$ref": "NodeTemplateAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified NodeTemplate resource.",
"httpMethod": "DELETE",
"id": "compute.nodeTemplates.delete",
"parameterOrder": [
"project",
"region",
"nodeTemplate"
],
"parameters": {
"nodeTemplate": {
"description": "Name of the NodeTemplate resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified node template. Gets a list of available node templates by making a list() request.",
"httpMethod": "GET",
"id": "compute.nodeTemplates.get",
"parameterOrder": [
"project",
"region",
"nodeTemplate"
],
"parameters": {
"nodeTemplate": {
"description": "Name of the node template to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
"response": {
"$ref": "NodeTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.nodeTemplates.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a NodeTemplate resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.nodeTemplates.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates",
"request": {
"$ref": "NodeTemplate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of node templates available to the specified project.",
"httpMethod": "GET",
"id": "compute.nodeTemplates.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates",
"response": {
"$ref": "NodeTemplateList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.nodeTemplates.setIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
"request": {
"$ref": "RegionSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.nodeTemplates.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"nodeTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of node types.",
"httpMethod": "GET",
"id": "compute.nodeTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/nodeTypes",
"response": {
"$ref": "NodeTypeAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"get": {
"description": "Returns the specified node type. Gets a list of available node types by making a list() request.",
"httpMethod": "GET",
"id": "compute.nodeTypes.get",
"parameterOrder": [
"project",
"zone",
"nodeType"
],
"parameters": {
"nodeType": {
"description": "Name of the node type to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeTypes/{nodeType}",
"response": {
"$ref": "NodeType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of node types available to the specified project.",
"httpMethod": "GET",
"id": "compute.nodeTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/nodeTypes",
"response": {
"$ref": "NodeTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"packetMirrorings": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of packetMirrorings.",
"httpMethod": "GET",
"id": "compute.packetMirrorings.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/packetMirrorings",
"response": {
"$ref": "PacketMirroringAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified PacketMirroring resource.",
"httpMethod": "DELETE",
"id": "compute.packetMirrorings.delete",
"parameterOrder": [
"project",
"region",
"packetMirroring"
],
"parameters": {
"packetMirroring": {
"description": "Name of the PacketMirroring resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified PacketMirroring resource.",
"httpMethod": "GET",
"id": "compute.packetMirrorings.get",
"parameterOrder": [
"project",
"region",
"packetMirroring"
],
"parameters": {
"packetMirroring": {
"description": "Name of the PacketMirroring resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"response": {
"$ref": "PacketMirroring"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a PacketMirroring resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.packetMirrorings.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings",
"request": {
"$ref": "PacketMirroring"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of PacketMirroring resources available to the specified project and region.",
"httpMethod": "GET",
"id": "compute.packetMirrorings.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings",
"response": {
"$ref": "PacketMirroringList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.packetMirrorings.patch",
"parameterOrder": [
"project",
"region",
"packetMirroring"
],
"parameters": {
"packetMirroring": {
"description": "Name of the PacketMirroring resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"request": {
"$ref": "PacketMirroring"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.packetMirrorings.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"projects": {
"methods": {
"disableXpnHost": {
"description": "Disable this project as a shared VPC host project.",
"httpMethod": "POST",
"id": "compute.projects.disableXpnHost",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/disableXpnHost",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"disableXpnResource": {
"description": "Disable a service resource (also known as service project) associated with this host project.",
"httpMethod": "POST",
"id": "compute.projects.disableXpnResource",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/disableXpnResource",
"request": {
"$ref": "ProjectsDisableXpnResourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"enableXpnHost": {
"description": "Enable this project as a shared VPC host project.",
"httpMethod": "POST",
"id": "compute.projects.enableXpnHost",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/enableXpnHost",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"enableXpnResource": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.projects.enableXpnResource",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/enableXpnResource",
"request": {
"$ref": "ProjectsEnableXpnResourceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Project resource.",
"httpMethod": "GET",
"id": "compute.projects.get",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}",
"response": {
"$ref": "Project"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getXpnHost": {
"description": "Gets the shared VPC host project that this project links to. May be empty if no link exists.",
"httpMethod": "GET",
"id": "compute.projects.getXpnHost",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/getXpnHost",
"response": {
"$ref": "Project"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"getXpnResources": {
"description": "Gets service resources (a.k.a service project) associated with this host project.",
"httpMethod": "GET",
"id": "compute.projects.getXpnResources",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/getXpnResources",
"response": {
"$ref": "ProjectsGetXpnResources"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"listXpnHosts": {
"description": "Lists all shared VPC host projects visible to the user in an organization.",
"httpMethod": "POST",
"id": "compute.projects.listXpnHosts",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/listXpnHosts",
"request": {
"$ref": "ProjectsListXpnHostsRequest"
},
"response": {
"$ref": "XpnHostList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"moveDisk": {
"description": "Moves a persistent disk from one zone to another.",
"httpMethod": "POST",
"id": "compute.projects.moveDisk",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/moveDisk",
"request": {
"$ref": "DiskMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"moveInstance": {
"description": "Moves an instance and its attached persistent disks from one zone to another.",
"httpMethod": "POST",
"id": "compute.projects.moveInstance",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/moveInstance",
"request": {
"$ref": "InstanceMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setCommonInstanceMetadata": {
"description": "Sets metadata common to all instances within the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.projects.setCommonInstanceMetadata",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/setCommonInstanceMetadata",
"request": {
"$ref": "Metadata"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setDefaultNetworkTier": {
"description": "Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.",
"httpMethod": "POST",
"id": "compute.projects.setDefaultNetworkTier",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/setDefaultNetworkTier",
"request": {
"$ref": "ProjectsSetDefaultNetworkTierRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUsageExportBucket": {
"description": "Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.",
"httpMethod": "POST",
"id": "compute.projects.setUsageExportBucket",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/setUsageExportBucket",
"request": {
"$ref": "UsageExportLocation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/devstorage.full_control",
"https://www.googleapis.com/auth/devstorage.read_only",
"https://www.googleapis.com/auth/devstorage.read_write"
]
}
}
},
"regionAutoscalers": {
"methods": {
"delete": {
"description": "Deletes the specified autoscaler.",
"httpMethod": "DELETE",
"id": "compute.regionAutoscalers.delete",
"parameterOrder": [
"project",
"region",
"autoscaler"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers/{autoscaler}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified autoscaler.",
"httpMethod": "GET",
"id": "compute.regionAutoscalers.get",
"parameterOrder": [
"project",
"region",
"autoscaler"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers/{autoscaler}",
"response": {
"$ref": "Autoscaler"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates an autoscaler in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionAutoscalers.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of autoscalers contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionAutoscalers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers",
"response": {
"$ref": "RegionAutoscalerList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.regionAutoscalers.patch",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to patch.",
"location": "query",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates an autoscaler in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.regionAutoscalers.update",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"autoscaler": {
"description": "Name of the autoscaler to update.",
"location": "query",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionBackendServices": {
"methods": {
"delete": {
"description": "Deletes the specified regional BackendService resource.",
"httpMethod": "DELETE",
"id": "compute.regionBackendServices.delete",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices/{backendService}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified regional BackendService resource.",
"httpMethod": "GET",
"id": "compute.regionBackendServices.get",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices/{backendService}",
"response": {
"$ref": "BackendService"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getHealth": {
"description": "Gets the most recent health check results for this regional BackendService.",
"httpMethod": "POST",
"id": "compute.regionBackendServices.getHealth",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource for which to get health.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices/{backendService}/getHealth",
"request": {
"$ref": "ResourceGroupReference"
},
"response": {
"$ref": "BackendServiceGroupHealth"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a regional BackendService resource in the specified project using the data included in the request. There are several restrictions and guidelines to keep in mind when creating a regional backend service. Read Understanding backend services for more information.",
"httpMethod": "POST",
"id": "compute.regionBackendServices.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of regional BackendService resources available to the specified project in the given region.",
"httpMethod": "GET",
"id": "compute.regionBackendServices.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices",
"response": {
"$ref": "BackendServiceList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Updates the specified regional BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.regionBackendServices.patch",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates the specified regional BackendService resource with the data included in the request. There are several Understanding backend services to keep in mind when updating a backend service. Read Understanding backend services for more information.",
"httpMethod": "PUT",
"id": "compute.regionBackendServices.update",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionCommitments": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of commitments.",
"httpMethod": "GET",
"id": "compute.regionCommitments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/commitments",
"response": {
"$ref": "CommitmentAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"get": {
"description": "Returns the specified commitment resource. Gets a list of available commitments by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionCommitments.get",
"parameterOrder": [
"project",
"region",
"commitment"
],
"parameters": {
"commitment": {
"description": "Name of the commitment to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/commitments/{commitment}",
"response": {
"$ref": "Commitment"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a commitment in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionCommitments.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/commitments",
"request": {
"$ref": "Commitment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of commitments contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionCommitments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/commitments",
"response": {
"$ref": "CommitmentList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionDiskTypes": {
"methods": {
"get": {
"description": "Returns the specified regional disk type. Gets a list of available disk types by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionDiskTypes.get",
"parameterOrder": [
"project",
"region",
"diskType"
],
"parameters": {
"diskType": {
"description": "Name of the disk type to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/diskTypes/{diskType}",
"response": {
"$ref": "DiskType"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of regional disk types available to the specified project.",
"httpMethod": "GET",
"id": "compute.regionDiskTypes.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/diskTypes",
"response": {
"$ref": "RegionDiskTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionDisks": {
"methods": {
"addResourcePolicies": {
"description": "Adds existing resource policies to a regional disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation.",
"httpMethod": "POST",
"id": "compute.regionDisks.addResourcePolicies",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "The disk name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}/addResourcePolicies",
"request": {
"$ref": "RegionDisksAddResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"createSnapshot": {
"description": "Creates a snapshot of this regional disk.",
"httpMethod": "POST",
"id": "compute.regionDisks.createSnapshot",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the regional persistent disk to snapshot.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}/createSnapshot",
"request": {
"$ref": "Snapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.",
"httpMethod": "DELETE",
"id": "compute.regionDisks.delete",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the regional persistent disk to delete.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns a specified regional persistent disk.",
"httpMethod": "GET",
"id": "compute.regionDisks.get",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the regional persistent disk to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}",
"response": {
"$ref": "Disk"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.regionDisks.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a persistent regional disk in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionDisks.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceImage": {
"description": "Optional. Source image to restore onto a disk.",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks",
"request": {
"$ref": "Disk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of persistent disks contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionDisks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks",
"response": {
"$ref": "DiskList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"removeResourcePolicies": {
"description": "Removes resource policies from a regional disk.",
"httpMethod": "POST",
"id": "compute.regionDisks.removeResourcePolicies",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "The disk name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
"request": {
"$ref": "RegionDisksRemoveResourcePoliciesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"description": "Resizes the specified regional persistent disk.",
"httpMethod": "POST",
"id": "compute.regionDisks.resize",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the regional persistent disk.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "The project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{disk}/resize",
"request": {
"$ref": "RegionDisksResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.regionDisks.setIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{resource}/setIamPolicy",
"request": {
"$ref": "RegionSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on the target regional disk.",
"httpMethod": "POST",
"id": "compute.regionDisks.setLabels",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.regionDisks.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/disks/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionHealthChecks": {
"methods": {
"delete": {
"description": "Deletes the specified HealthCheck resource.",
"httpMethod": "DELETE",
"id": "compute.regionHealthChecks.delete",
"parameterOrder": [
"project",
"region",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks/{healthCheck}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionHealthChecks.get",
"parameterOrder": [
"project",
"region",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks/{healthCheck}",
"response": {
"$ref": "HealthCheck"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a HealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionHealthChecks.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of HealthCheck resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.regionHealthChecks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks",
"response": {
"$ref": "HealthCheckList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.regionHealthChecks.patch",
"parameterOrder": [
"project",
"region",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks/{healthCheck}",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates a HealthCheck resource in the specified project using the data included in the request.",
"httpMethod": "PUT",
"id": "compute.regionHealthChecks.update",
"parameterOrder": [
"project",
"region",
"healthCheck"
],
"parameters": {
"healthCheck": {
"description": "Name of the HealthCheck resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/healthChecks/{healthCheck}",
"request": {
"$ref": "HealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionInstanceGroupManagers": {
"methods": {
"abandonInstances": {
"description": "Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.abandonInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"request": {
"$ref": "RegionInstanceGroupManagersAbandonInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"applyUpdatesToInstances": {
"description": "Apply updates to selected instances the managed instance group.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.applyUpdatesToInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group, should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request, should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
"request": {
"$ref": "RegionInstanceGroupManagersApplyUpdatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"createInstances": {
"description": "Creates instances with per-instance configs in this regional managed instance group. Instances are created using the current instance template. The create instances operation is marked DONE if the createInstances request is successful. The underlying actions take additional time. You must separately verify the status of the creating or actions with the listmanagedinstances method.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.createInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region where the managed instance group is located. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances",
"request": {
"$ref": "RegionInstanceGroupManagersCreateInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified managed instance group and all of the instances in that group.",
"httpMethod": "DELETE",
"id": "compute.regionInstanceGroupManagers.delete",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group to delete.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteInstances": {
"description": "Flags the specified instances in the managed instance group to be immediately deleted. The instances are also removed from any target pools of which they were a member. This method reduces the targetSize of the managed instance group by the number of instances that you delete. The deleteInstances operation is marked DONE if the deleteInstances request is successful. The underlying actions take additional time. You must separately verify the status of the deleting action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.deleteInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"request": {
"$ref": "RegionInstanceGroupManagersDeleteInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns all of the details about the specified managed instance group.",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagers.get",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group to return.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"response": {
"$ref": "InstanceGroupManager"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method.\n\nA regional managed instance group can contain up to 2000 instances.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers",
"request": {
"$ref": "InstanceGroupManager"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of managed instance groups that are contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers",
"response": {
"$ref": "RegionInstanceGroupManagerList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listErrors": {
"description": "Lists all errors thrown by actions on instances for a given regional managed instance group.",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagers.listErrors",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. It must be a string that meets the requirements in RFC1035, or an unsigned long integer: must match regexp pattern: (?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|[1-9][0-9]{0,19}.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request. This should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors",
"response": {
"$ref": "RegionInstanceGroupManagersListErrorsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listManagedInstances": {
"description": "Lists the instances in the managed instance group and instances that are scheduled to be created. The list includes any current actions that the group has scheduled for its instances.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.listManagedInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
"response": {
"$ref": "RegionInstanceGroupManagersListInstancesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.regionInstanceGroupManagers.patch",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the instance group manager.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"request": {
"$ref": "InstanceGroupManager"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"recreateInstances": {
"description": "Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. This operation is marked as DONE when the flag is set even if the instances have not yet been recreated. You must separately verify the status of the recreating action with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.recreateInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"request": {
"$ref": "RegionInstanceGroupManagersRecreateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"description": "Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances.\n\nThe resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method.\n\nIf the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.resize",
"parameterOrder": [
"project",
"region",
"instanceGroupManager",
"size"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"size": {
"description": "Number of instances that should exist in this instance group manager.",
"format": "int32",
"location": "query",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setInstanceTemplate": {
"description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.setInstanceTemplate",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
"request": {
"$ref": "RegionInstanceGroupManagersSetTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setTargetPools": {
"description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.setTargetPools",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
"request": {
"$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionInstanceGroups": {
"methods": {
"get": {
"description": "Returns the specified instance group resource.",
"httpMethod": "GET",
"id": "compute.regionInstanceGroups.get",
"parameterOrder": [
"project",
"region",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "Name of the instance group resource to return.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroups/{instanceGroup}",
"response": {
"$ref": "InstanceGroup"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves the list of instance group resources contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionInstanceGroups.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroups",
"response": {
"$ref": "RegionInstanceGroupList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listInstances": {
"description": "Lists the instances in the specified instance group and displays information about the named ports. Depending on the specified options, this method can list all instances or only the instances that are running.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroups.listInstances",
"parameterOrder": [
"project",
"region",
"instanceGroup"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"instanceGroup": {
"description": "Name of the regional instance group for which we want to list the instances.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
"request": {
"$ref": "RegionInstanceGroupsListInstancesRequest"
},
"response": {
"$ref": "RegionInstanceGroupsListInstances"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setNamedPorts": {
"description": "Sets the named ports for the specified regional instance group.",
"httpMethod": "POST",
"id": "compute.regionInstanceGroups.setNamedPorts",
"parameterOrder": [
"project",
"region",
"instanceGroup"
],
"parameters": {
"instanceGroup": {
"description": "The name of the regional instance group where the named ports are updated.",
"location": "path",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
"request": {
"$ref": "RegionInstanceGroupsSetNamedPortsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionOperations": {
"methods": {
"delete": {
"description": "Deletes the specified region-specific Operations resource.",
"httpMethod": "DELETE",
"id": "compute.regionOperations.delete",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/operations/{operation}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves the specified region-specific Operations resource.",
"httpMethod": "GET",
"id": "compute.regionOperations.get",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/operations/{operation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of Operation resources contained within the specified region.",
"httpMethod": "GET",
"id": "compute.regionOperations.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/operations",
"response": {
"$ref": "OperationList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"wait": {
"description": "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.\n\nThis method is called on a best-effort basis. Specifically: \n- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. \n- 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`.",
"httpMethod": "POST",
"id": "compute.regionOperations.wait",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/operations/{operation}/wait",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionSslCertificates": {
"methods": {
"delete": {
"description": "Deletes the specified SslCertificate resource in the region.",
"httpMethod": "DELETE",
"id": "compute.regionSslCertificates.delete",
"parameterOrder": [
"project",
"region",
"sslCertificate"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sslCertificate": {
"description": "Name of the SslCertificate resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/sslCertificates/{sslCertificate}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionSslCertificates.get",
"parameterOrder": [
"project",
"region",
"sslCertificate"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"sslCertificate": {
"description": "Name of the SslCertificate resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/sslCertificates/{sslCertificate}",
"response": {
"$ref": "SslCertificate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a SslCertificate resource in the specified project and region using the data included in the request",
"httpMethod": "POST",
"id": "compute.regionSslCertificates.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/sslCertificates",
"request": {
"$ref": "SslCertificate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of SslCertificate resources available to the specified project in the specified region.",
"httpMethod": "GET",
"id": "compute.regionSslCertificates.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/sslCertificates",
"response": {
"$ref": "SslCertificateList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionTargetHttpProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetHttpProxy resource.",
"httpMethod": "DELETE",
"id": "compute.regionTargetHttpProxies.delete",
"parameterOrder": [
"project",
"region",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionTargetHttpProxies.get",
"parameterOrder": [
"project",
"region",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
"response": {
"$ref": "TargetHttpProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetHttpProxy resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionTargetHttpProxies.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpProxies",
"request": {
"$ref": "TargetHttpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region.",
"httpMethod": "GET",
"id": "compute.regionTargetHttpProxies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpProxies",
"response": {
"$ref": "TargetHttpProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setUrlMap": {
"description": "Changes the URL map for TargetHttpProxy.",
"httpMethod": "POST",
"id": "compute.regionTargetHttpProxies.setUrlMap",
"parameterOrder": [
"project",
"region",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy to set a URL map for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionTargetHttpsProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetHttpsProxy resource.",
"httpMethod": "DELETE",
"id": "compute.regionTargetHttpsProxies.delete",
"parameterOrder": [
"project",
"region",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionTargetHttpsProxies.get",
"parameterOrder": [
"project",
"region",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"response": {
"$ref": "TargetHttpsProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionTargetHttpsProxies.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies",
"request": {
"$ref": "TargetHttpsProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region.",
"httpMethod": "GET",
"id": "compute.regionTargetHttpsProxies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies",
"response": {
"$ref": "TargetHttpsProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setSslCertificates": {
"description": "Replaces SslCertificates for TargetHttpsProxy.",
"httpMethod": "POST",
"id": "compute.regionTargetHttpsProxies.setSslCertificates",
"parameterOrder": [
"project",
"region",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
"request": {
"$ref": "RegionTargetHttpsProxiesSetSslCertificatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUrlMap": {
"description": "Changes the URL map for TargetHttpsProxy.",
"httpMethod": "POST",
"id": "compute.regionTargetHttpsProxies.setUrlMap",
"parameterOrder": [
"project",
"region",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy to set a URL map for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionUrlMaps": {
"methods": {
"delete": {
"description": "Deletes the specified UrlMap resource.",
"httpMethod": "DELETE",
"id": "compute.regionUrlMaps.delete",
"parameterOrder": [
"project",
"region",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps/{urlMap}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.",
"httpMethod": "GET",
"id": "compute.regionUrlMaps.get",
"parameterOrder": [
"project",
"region",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps/{urlMap}",
"response": {
"$ref": "UrlMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a UrlMap resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.regionUrlMaps.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of UrlMap resources available to the specified project in the specified region.",
"httpMethod": "GET",
"id": "compute.regionUrlMaps.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps",
"response": {
"$ref": "UrlMapList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.regionUrlMaps.patch",
"parameterOrder": [
"project",
"region",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps/{urlMap}",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates the specified UrlMap resource with the data included in the request.",
"httpMethod": "PUT",
"id": "compute.regionUrlMaps.update",
"parameterOrder": [
"project",
"region",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "begin_interface: MixerMutationRequestBuilder Request ID to support idempotency.",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps/{urlMap}",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"validate": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.regionUrlMaps.validate",
"parameterOrder": [
"project",
"region",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to be validated as.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/urlMaps/{urlMap}/validate",
"request": {
"$ref": "RegionUrlMapsValidateRequest"
},
"response": {
"$ref": "UrlMapsValidateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regions": {
"methods": {
"get": {
"description": "Returns the specified Region resource. Gets a list of available regions by making a list() request.",
"httpMethod": "GET",
"id": "compute.regions.get",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}",
"response": {
"$ref": "Region"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves the list of region resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.regions.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/regions",
"response": {
"$ref": "RegionList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"reservations": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of reservations.",
"httpMethod": "GET",
"id": "compute.reservations.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/reservations",
"response": {
"$ref": "ReservationAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified reservation.",
"httpMethod": "DELETE",
"id": "compute.reservations.delete",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservation": {
"description": "Name of the reservation to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{reservation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves information about the specified reservation.",
"httpMethod": "GET",
"id": "compute.reservations.get",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"reservation": {
"description": "Name of the reservation to retrieve.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{reservation}",
"response": {
"$ref": "Reservation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.reservations.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a new reservation. For more information, read Reserving zonal resources.",
"httpMethod": "POST",
"id": "compute.reservations.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations",
"request": {
"$ref": "Reservation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "A list of all the reservations that have been configured for the specified project in specified zone.",
"httpMethod": "GET",
"id": "compute.reservations.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations",
"response": {
"$ref": "ReservationList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"resize": {
"description": "Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations.",
"httpMethod": "POST",
"id": "compute.reservations.resize",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservation": {
"description": "Name of the reservation to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{reservation}/resize",
"request": {
"$ref": "ReservationsResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.reservations.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.reservations.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"resourcePolicies": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of resource policies.",
"httpMethod": "GET",
"id": "compute.resourcePolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/resourcePolicies",
"response": {
"$ref": "ResourcePolicyAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified resource policy.",
"httpMethod": "DELETE",
"id": "compute.resourcePolicies.delete",
"parameterOrder": [
"project",
"region",
"resourcePolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resourcePolicy": {
"description": "Name of the resource policy to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves all information of the specified resource policy.",
"httpMethod": "GET",
"id": "compute.resourcePolicies.get",
"parameterOrder": [
"project",
"region",
"resourcePolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resourcePolicy": {
"description": "Name of the resource policy to retrieve.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"response": {
"$ref": "ResourcePolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.resourcePolicies.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a new resource policy.",
"httpMethod": "POST",
"id": "compute.resourcePolicies.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies",
"request": {
"$ref": "ResourcePolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "A list all the resource policies that have been configured for the specified project in specified region.",
"httpMethod": "GET",
"id": "compute.resourcePolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies",
"response": {
"$ref": "ResourcePolicyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.resourcePolicies.setIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
"request": {
"$ref": "RegionSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.resourcePolicies.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"routers": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of routers.",
"httpMethod": "GET",
"id": "compute.routers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/routers",
"response": {
"$ref": "RouterAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified Router resource.",
"httpMethod": "DELETE",
"id": "compute.routers.delete",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Router resource. Gets a list of available routers by making a list() request.",
"httpMethod": "GET",
"id": "compute.routers.get",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"router": {
"description": "Name of the Router resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}",
"response": {
"$ref": "Router"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getNatMappingInfo": {
"description": "Retrieves runtime Nat mapping information of VM endpoints.",
"httpMethod": "GET",
"id": "compute.routers.getNatMappingInfo",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"router": {
"description": "Name of the Router resource to query for Nat Mapping information of VM endpoints.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}/getNatMappingInfo",
"response": {
"$ref": "VmEndpointNatMappingsList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getRouterStatus": {
"description": "Retrieves runtime information of the specified router.",
"httpMethod": "GET",
"id": "compute.routers.getRouterStatus",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"router": {
"description": "Name of the Router resource to query.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}/getRouterStatus",
"response": {
"$ref": "RouterStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a Router resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.routers.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/routers",
"request": {
"$ref": "Router"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of Router resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.routers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers",
"response": {
"$ref": "RouterList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.",
"httpMethod": "PATCH",
"id": "compute.routers.patch",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}",
"request": {
"$ref": "Router"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"preview": {
"description": "Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router.",
"httpMethod": "POST",
"id": "compute.routers.preview",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"router": {
"description": "Name of the Router resource to query.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}/preview",
"request": {
"$ref": "Router"
},
"response": {
"$ref": "RoutersPreviewResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload.",
"httpMethod": "PUT",
"id": "compute.routers.update",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/routers/{router}",
"request": {
"$ref": "Router"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"routes": {
"methods": {
"delete": {
"description": "Deletes the specified Route resource.",
"httpMethod": "DELETE",
"id": "compute.routes.delete",
"parameterOrder": [
"project",
"route"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"route": {
"description": "Name of the Route resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/routes/{route}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Route resource. Gets a list of available routes by making a list() request.",
"httpMethod": "GET",
"id": "compute.routes.get",
"parameterOrder": [
"project",
"route"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"route": {
"description": "Name of the Route resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/routes/{route}",
"response": {
"$ref": "Route"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a Route resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.routes.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/routes",
"request": {
"$ref": "Route"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of Route resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.routes.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/routes",
"response": {
"$ref": "RouteList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"securityPolicies": {
"methods": {
"addRule": {
"description": "Inserts a rule into a security policy.",
"httpMethod": "POST",
"id": "compute.securityPolicies.addRule",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}/addRule",
"request": {
"$ref": "SecurityPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified policy.",
"httpMethod": "DELETE",
"id": "compute.securityPolicies.delete",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "List all of the ordered rules present in a single specified policy.",
"httpMethod": "GET",
"id": "compute.securityPolicies.get",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to get.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}",
"response": {
"$ref": "SecurityPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getRule": {
"description": "Gets a rule at the specified priority.",
"httpMethod": "GET",
"id": "compute.securityPolicies.getRule",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to get from the security policy.",
"format": "int32",
"location": "query",
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to which the queried rule belongs.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}/getRule",
"response": {
"$ref": "SecurityPolicyRule"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a new policy in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.securityPolicies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/securityPolicies",
"request": {
"$ref": "SecurityPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "List all the policies that have been configured for the specified project.",
"httpMethod": "GET",
"id": "compute.securityPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies",
"response": {
"$ref": "SecurityPolicyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listPreconfiguredExpressionSets": {
"description": "Gets the current list of preconfigured Web Application Firewall (WAF) expressions.",
"httpMethod": "GET",
"id": "compute.securityPolicies.listPreconfiguredExpressionSets",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/listPreconfiguredExpressionSets",
"response": {
"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patch": {
"description": "Patches the specified policy with the data included in the request.",
"httpMethod": "PATCH",
"id": "compute.securityPolicies.patch",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}",
"request": {
"$ref": "SecurityPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patchRule": {
"description": "Patches a rule at the specified priority.",
"httpMethod": "POST",
"id": "compute.securityPolicies.patchRule",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to patch.",
"format": "int32",
"location": "query",
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}/patchRule",
"request": {
"$ref": "SecurityPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeRule": {
"description": "Deletes a rule at the specified priority.",
"httpMethod": "POST",
"id": "compute.securityPolicies.removeRule",
"parameterOrder": [
"project",
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to remove from the security policy.",
"format": "int32",
"location": "query",
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/securityPolicies/{securityPolicy}/removeRule",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"snapshots": {
"methods": {
"delete": {
"description": "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.\n\nFor more information, see Deleting snapshots.",
"httpMethod": "DELETE",
"id": "compute.snapshots.delete",
"parameterOrder": [
"project",
"snapshot"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"snapshot": {
"description": "Name of the Snapshot resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{snapshot}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request.",
"httpMethod": "GET",
"id": "compute.snapshots.get",
"parameterOrder": [
"project",
"snapshot"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"snapshot": {
"description": "Name of the Snapshot resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{snapshot}",
"response": {
"$ref": "Snapshot"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.snapshots.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves the list of Snapshot resources contained within the specified project.",
"httpMethod": "GET",
"id": "compute.snapshots.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots",
"response": {
"$ref": "SnapshotList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.snapshots.setIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.snapshots.setLabels",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.snapshots.testIamPermissions",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/snapshots/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"sslCertificates": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all SslCertificate resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.sslCertificates.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/sslCertificates",
"response": {
"$ref": "SslCertificateAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified SslCertificate resource.",
"httpMethod": "DELETE",
"id": "compute.sslCertificates.delete",
"parameterOrder": [
"project",
"sslCertificate"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sslCertificate": {
"description": "Name of the SslCertificate resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslCertificates/{sslCertificate}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request.",
"httpMethod": "GET",
"id": "compute.sslCertificates.get",
"parameterOrder": [
"project",
"sslCertificate"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"sslCertificate": {
"description": "Name of the SslCertificate resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslCertificates/{sslCertificate}",
"response": {
"$ref": "SslCertificate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a SslCertificate resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.sslCertificates.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/sslCertificates",
"request": {
"$ref": "SslCertificate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of SslCertificate resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.sslCertificates.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslCertificates",
"response": {
"$ref": "SslCertificateList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"sslPolicies": {
"methods": {
"delete": {
"description": "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.",
"httpMethod": "DELETE",
"id": "compute.sslPolicies.delete",
"parameterOrder": [
"project",
"sslPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sslPolicy": {
"description": "Name of the SSL policy to delete. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslPolicies/{sslPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Lists all of the ordered rules present in a single specified policy.",
"httpMethod": "GET",
"id": "compute.sslPolicies.get",
"parameterOrder": [
"project",
"sslPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"sslPolicy": {
"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslPolicies/{sslPolicy}",
"response": {
"$ref": "SslPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request.",
"httpMethod": "POST",
"id": "compute.sslPolicies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/sslPolicies",
"request": {
"$ref": "SslPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all the SSL policies that have been configured for the specified project.",
"httpMethod": "GET",
"id": "compute.sslPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslPolicies",
"response": {
"$ref": "SslPoliciesList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listAvailableFeatures": {
"description": "Lists all features that can be specified in the SSL policy when using custom profile.",
"httpMethod": "GET",
"id": "compute.sslPolicies.listAvailableFeatures",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslPolicies/listAvailableFeatures",
"response": {
"$ref": "SslPoliciesListAvailableFeaturesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified SSL policy with the data included in the request.",
"httpMethod": "PATCH",
"id": "compute.sslPolicies.patch",
"parameterOrder": [
"project",
"sslPolicy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sslPolicy": {
"description": "Name of the SSL policy to update. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/sslPolicies/{sslPolicy}",
"request": {
"$ref": "SslPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"subnetworks": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of subnetworks.",
"httpMethod": "GET",
"id": "compute.subnetworks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/subnetworks",
"response": {
"$ref": "SubnetworkAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified subnetwork.",
"httpMethod": "DELETE",
"id": "compute.subnetworks.delete",
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"subnetwork": {
"description": "Name of the Subnetwork resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{subnetwork}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"expandIpCidrRange": {
"description": "Expands the IP CIDR range of the subnetwork to a specified value.",
"httpMethod": "POST",
"id": "compute.subnetworks.expandIpCidrRange",
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"subnetwork": {
"description": "Name of the Subnetwork resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange",
"request": {
"$ref": "SubnetworksExpandIpCidrRangeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified subnetwork. Gets a list of available subnetworks list() request.",
"httpMethod": "GET",
"id": "compute.subnetworks.get",
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"subnetwork": {
"description": "Name of the Subnetwork resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{subnetwork}",
"response": {
"$ref": "Subnetwork"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such policy or resource exists.",
"httpMethod": "GET",
"id": "compute.subnetworks.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a subnetwork in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.subnetworks.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks",
"request": {
"$ref": "Subnetwork"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of subnetworks available to the specified project.",
"httpMethod": "GET",
"id": "compute.subnetworks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks",
"response": {
"$ref": "SubnetworkList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listUsable": {
"description": "Retrieves an aggregated list of all usable subnetworks in the project. The list contains all of the subnetworks in the project and the subnetworks that were shared by a Shared VPC host project.",
"httpMethod": "GET",
"id": "compute.subnetworks.listUsable",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/subnetworks/listUsable",
"response": {
"$ref": "UsableSubnetworksAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched.",
"httpMethod": "PATCH",
"id": "compute.subnetworks.patch",
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"parameters": {
"drainTimeoutSeconds": {
"description": "The drain timeout specifies the upper bound in seconds on the amount of time allowed to drain connections from the current ACTIVE subnetwork to the current BACKUP subnetwork. The drain timeout is only applicable when the following conditions are true: - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER - the subnetwork being patched has role = BACKUP - the patch request is setting the role to ACTIVE. Note that after this patch operation the roles of the ACTIVE and BACKUP subnetworks will be swapped.",
"format": "int32",
"location": "query",
"type": "integer"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"subnetwork": {
"description": "Name of the Subnetwork resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{subnetwork}",
"request": {
"$ref": "Subnetwork"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"httpMethod": "POST",
"id": "compute.subnetworks.setIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{resource}/setIamPolicy",
"request": {
"$ref": "RegionSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setPrivateIpGoogleAccess": {
"description": "Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.",
"httpMethod": "POST",
"id": "compute.subnetworks.setPrivateIpGoogleAccess",
"parameterOrder": [
"project",
"region",
"subnetwork"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"subnetwork": {
"description": "Name of the Subnetwork resource.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
"request": {
"$ref": "SubnetworksSetPrivateIpGoogleAccessRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.subnetworks.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"targetHttpProxies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetHttpProxies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/targetHttpProxies",
"response": {
"$ref": "TargetHttpProxyAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified TargetHttpProxy resource.",
"httpMethod": "DELETE",
"id": "compute.targetHttpProxies.delete",
"parameterOrder": [
"project",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetHttpProxies.get",
"parameterOrder": [
"project",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpProxies/{targetHttpProxy}",
"response": {
"$ref": "TargetHttpProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetHttpProxy resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetHttpProxies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/targetHttpProxies",
"request": {
"$ref": "TargetHttpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetHttpProxy resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetHttpProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpProxies",
"response": {
"$ref": "TargetHttpProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setUrlMap": {
"description": "Changes the URL map for TargetHttpProxy.",
"httpMethod": "POST",
"id": "compute.targetHttpProxies.setUrlMap",
"parameterOrder": [
"project",
"targetHttpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy to set a URL map for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetHttpsProxies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetHttpsProxies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/targetHttpsProxies",
"response": {
"$ref": "TargetHttpsProxyAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified TargetHttpsProxy resource.",
"httpMethod": "DELETE",
"id": "compute.targetHttpsProxies.delete",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetHttpsProxies.get",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"response": {
"$ref": "TargetHttpsProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetHttpsProxy resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies",
"request": {
"$ref": "TargetHttpsProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetHttpsProxy resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetHttpsProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies",
"response": {
"$ref": "TargetHttpsProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setQuicOverride": {
"description": "Sets the QUIC override policy for TargetHttpsProxy.",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.setQuicOverride",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
"request": {
"$ref": "TargetHttpsProxiesSetQuicOverrideRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSslCertificates": {
"description": "Replaces SslCertificates for TargetHttpsProxy.",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.setSslCertificates",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set an SslCertificates resource for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
"request": {
"$ref": "TargetHttpsProxiesSetSslCertificatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSslPolicy": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.setSslPolicy",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
"request": {
"$ref": "SslPolicyReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUrlMap": {
"description": "Changes the URL map for TargetHttpsProxy.",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.setUrlMap",
"parameterOrder": [
"project",
"targetHttpsProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource whose URL map is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
"request": {
"$ref": "UrlMapReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetInstances": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of target instances.",
"httpMethod": "GET",
"id": "compute.targetInstances.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/targetInstances",
"response": {
"$ref": "TargetInstanceAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified TargetInstance resource.",
"httpMethod": "DELETE",
"id": "compute.targetInstances.delete",
"parameterOrder": [
"project",
"zone",
"targetInstance"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetInstance": {
"description": "Name of the TargetInstance resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetInstances.get",
"parameterOrder": [
"project",
"zone",
"targetInstance"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"targetInstance": {
"description": "Name of the TargetInstance resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/targetInstances/{targetInstance}",
"response": {
"$ref": "TargetInstance"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetInstance resource in the specified project and zone using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetInstances.insert",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/targetInstances",
"request": {
"$ref": "TargetInstance"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of TargetInstance resources available to the specified project and zone.",
"httpMethod": "GET",
"id": "compute.targetInstances.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/targetInstances",
"response": {
"$ref": "TargetInstanceList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"targetPools": {
"methods": {
"addHealthCheck": {
"description": "Adds health check URLs to a target pool.",
"httpMethod": "POST",
"id": "compute.targetPools.addHealthCheck",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the target pool to add a health check to.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
"request": {
"$ref": "TargetPoolsAddHealthCheckRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addInstance": {
"description": "Adds an instance to a target pool.",
"httpMethod": "POST",
"id": "compute.targetPools.addInstance",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to add instances to.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/addInstance",
"request": {
"$ref": "TargetPoolsAddInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves an aggregated list of target pools.",
"httpMethod": "GET",
"id": "compute.targetPools.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/targetPools",
"response": {
"$ref": "TargetPoolAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified target pool.",
"httpMethod": "DELETE",
"id": "compute.targetPools.delete",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified target pool. Gets a list of available target pools by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetPools.get",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}",
"response": {
"$ref": "TargetPool"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getHealth": {
"description": "Gets the most recent health check results for each IP for the instance that is referenced by the given target pool.",
"httpMethod": "POST",
"id": "compute.targetPools.getHealth",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to which the queried instance belongs.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/getHealth",
"request": {
"$ref": "InstanceReference"
},
"response": {
"$ref": "TargetPoolInstanceHealth"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a target pool in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetPools.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools",
"request": {
"$ref": "TargetPool"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of target pools available to the specified project and region.",
"httpMethod": "GET",
"id": "compute.targetPools.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools",
"response": {
"$ref": "TargetPoolList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"removeHealthCheck": {
"description": "Removes health check URL from a target pool.",
"httpMethod": "POST",
"id": "compute.targetPools.removeHealthCheck",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the target pool to remove health checks from.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
"request": {
"$ref": "TargetPoolsRemoveHealthCheckRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeInstance": {
"description": "Removes instance URL from a target pool.",
"httpMethod": "POST",
"id": "compute.targetPools.removeInstance",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to remove instances from.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
"request": {
"$ref": "TargetPoolsRemoveInstanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setBackup": {
"description": "Changes a backup target pool's configurations.",
"httpMethod": "POST",
"id": "compute.targetPools.setBackup",
"parameterOrder": [
"project",
"region",
"targetPool"
],
"parameters": {
"failoverRatio": {
"description": "New failoverRatio value for the target pool.",
"format": "float",
"location": "query",
"type": "number"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to set a backup pool for.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetPools/{targetPool}/setBackup",
"request": {
"$ref": "TargetReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetSslProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetSslProxy resource.",
"httpMethod": "DELETE",
"id": "compute.targetSslProxies.delete",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetSslProxies.get",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}",
"response": {
"$ref": "TargetSslProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetSslProxy resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetSslProxies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/targetSslProxies",
"request": {
"$ref": "TargetSslProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetSslProxy resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetSslProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies",
"response": {
"$ref": "TargetSslProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setBackendService": {
"description": "Changes the BackendService for TargetSslProxy.",
"httpMethod": "POST",
"id": "compute.targetSslProxies.setBackendService",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose BackendService resource is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
"request": {
"$ref": "TargetSslProxiesSetBackendServiceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setProxyHeader": {
"description": "Changes the ProxyHeaderType for TargetSslProxy.",
"httpMethod": "POST",
"id": "compute.targetSslProxies.setProxyHeader",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose ProxyHeader is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
"request": {
"$ref": "TargetSslProxiesSetProxyHeaderRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSslCertificates": {
"description": "Changes SslCertificates for TargetSslProxy.",
"httpMethod": "POST",
"id": "compute.targetSslProxies.setSslCertificates",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose SslCertificate resource is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
"request": {
"$ref": "TargetSslProxiesSetSslCertificatesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSslPolicy": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.targetSslProxies.setSslPolicy",
"parameterOrder": [
"project",
"targetSslProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose SSL policy is to be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
"request": {
"$ref": "SslPolicyReference"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetTcpProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetTcpProxy resource.",
"httpMethod": "DELETE",
"id": "compute.targetTcpProxies.delete",
"parameterOrder": [
"project",
"targetTcpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetTcpProxy": {
"description": "Name of the TargetTcpProxy resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetTcpProxies.get",
"parameterOrder": [
"project",
"targetTcpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"targetTcpProxy": {
"description": "Name of the TargetTcpProxy resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies/{targetTcpProxy}",
"response": {
"$ref": "TargetTcpProxy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a TargetTcpProxy resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetTcpProxies.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies",
"request": {
"$ref": "TargetTcpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of TargetTcpProxy resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.targetTcpProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies",
"response": {
"$ref": "TargetTcpProxyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setBackendService": {
"description": "Changes the BackendService for TargetTcpProxy.",
"httpMethod": "POST",
"id": "compute.targetTcpProxies.setBackendService",
"parameterOrder": [
"project",
"targetTcpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetTcpProxy": {
"description": "Name of the TargetTcpProxy resource whose BackendService resource is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
"request": {
"$ref": "TargetTcpProxiesSetBackendServiceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setProxyHeader": {
"description": "Changes the ProxyHeaderType for TargetTcpProxy.",
"httpMethod": "POST",
"id": "compute.targetTcpProxies.setProxyHeader",
"parameterOrder": [
"project",
"targetTcpProxy"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetTcpProxy": {
"description": "Name of the TargetTcpProxy resource whose ProxyHeader is to be set.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
"request": {
"$ref": "TargetTcpProxiesSetProxyHeaderRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetVpnGateways": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of target VPN gateways.",
"httpMethod": "GET",
"id": "compute.targetVpnGateways.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/targetVpnGateways",
"response": {
"$ref": "TargetVpnGatewayAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified target VPN gateway.",
"httpMethod": "DELETE",
"id": "compute.targetVpnGateways.delete",
"parameterOrder": [
"project",
"region",
"targetVpnGateway"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetVpnGateway": {
"description": "Name of the target VPN gateway to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request.",
"httpMethod": "GET",
"id": "compute.targetVpnGateways.get",
"parameterOrder": [
"project",
"region",
"targetVpnGateway"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"targetVpnGateway": {
"description": "Name of the target VPN gateway to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"response": {
"$ref": "TargetVpnGateway"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a target VPN gateway in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.targetVpnGateways.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/targetVpnGateways",
"request": {
"$ref": "TargetVpnGateway"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of target VPN gateways available to the specified project and region.",
"httpMethod": "GET",
"id": "compute.targetVpnGateways.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/targetVpnGateways",
"response": {
"$ref": "TargetVpnGatewayList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"urlMaps": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all UrlMap resources, regional and global, available to the specified project.",
"httpMethod": "GET",
"id": "compute.urlMaps.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Name of the project scoping this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/urlMaps",
"response": {
"$ref": "UrlMapsAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified UrlMap resource.",
"httpMethod": "DELETE",
"id": "compute.urlMaps.delete",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request.",
"httpMethod": "GET",
"id": "compute.urlMaps.get",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}",
"response": {
"$ref": "UrlMap"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a UrlMap resource in the specified project using the data included in the request.",
"httpMethod": "POST",
"id": "compute.urlMaps.insert",
"parameterOrder": [
"project"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/global/urlMaps",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"invalidateCache": {
"description": "Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap.",
"httpMethod": "POST",
"id": "compute.urlMaps.invalidateCache",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}/invalidateCache",
"request": {
"$ref": "CacheInvalidationRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of UrlMap resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.urlMaps.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps",
"response": {
"$ref": "UrlMapList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "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.",
"httpMethod": "PATCH",
"id": "compute.urlMaps.patch",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to patch.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"update": {
"description": "Updates the specified UrlMap resource with the data included in the request.",
"httpMethod": "PUT",
"id": "compute.urlMaps.update",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to update.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}",
"request": {
"$ref": "UrlMap"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"validate": {
"description": "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.",
"httpMethod": "POST",
"id": "compute.urlMaps.validate",
"parameterOrder": [
"project",
"urlMap"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"urlMap": {
"description": "Name of the UrlMap resource to be validated as.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/global/urlMaps/{urlMap}/validate",
"request": {
"$ref": "UrlMapsValidateRequest"
},
"response": {
"$ref": "UrlMapsValidateResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"vpnGateways": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of VPN gateways.",
"httpMethod": "GET",
"id": "compute.vpnGateways.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/vpnGateways",
"response": {
"$ref": "VpnGatewayAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified VPN gateway.",
"httpMethod": "DELETE",
"id": "compute.vpnGateways.delete",
"parameterOrder": [
"project",
"region",
"vpnGateway"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"vpnGateway": {
"description": "Name of the VPN gateway to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways/{vpnGateway}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request.",
"httpMethod": "GET",
"id": "compute.vpnGateways.get",
"parameterOrder": [
"project",
"region",
"vpnGateway"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"vpnGateway": {
"description": "Name of the VPN gateway to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways/{vpnGateway}",
"response": {
"$ref": "VpnGateway"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getStatus": {
"description": "Returns the status for the specified VPN gateway.",
"httpMethod": "GET",
"id": "compute.vpnGateways.getStatus",
"parameterOrder": [
"project",
"region",
"vpnGateway"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"vpnGateway": {
"description": "Name of the VPN gateway to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus",
"response": {
"$ref": "VpnGatewaysGetStatusResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a VPN gateway in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.vpnGateways.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways",
"request": {
"$ref": "VpnGateway"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of VPN gateways available to the specified project and region.",
"httpMethod": "GET",
"id": "compute.vpnGateways.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways",
"response": {
"$ref": "VpnGatewayList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"setLabels": {
"description": "Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation.",
"httpMethod": "POST",
"id": "compute.vpnGateways.setLabels",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"httpMethod": "POST",
"id": "compute.vpnGateways.testIamPermissions",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "The name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
"request": {
"$ref": "TestPermissionsRequest"
},
"response": {
"$ref": "TestPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"vpnTunnels": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of VPN tunnels.",
"httpMethod": "GET",
"id": "compute.vpnTunnels.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "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.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/aggregated/vpnTunnels",
"response": {
"$ref": "VpnTunnelAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Deletes the specified VpnTunnel resource.",
"httpMethod": "DELETE",
"id": "compute.vpnTunnels.delete",
"parameterOrder": [
"project",
"region",
"vpnTunnel"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"vpnTunnel": {
"description": "Name of the VpnTunnel resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request.",
"httpMethod": "GET",
"id": "compute.vpnTunnels.get",
"parameterOrder": [
"project",
"region",
"vpnTunnel"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"vpnTunnel": {
"description": "Name of the VpnTunnel resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"response": {
"$ref": "VpnTunnel"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"insert": {
"description": "Creates a VpnTunnel resource in the specified project and region using the data included in the request.",
"httpMethod": "POST",
"id": "compute.vpnTunnels.insert",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.\n\nFor example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnTunnels",
"request": {
"$ref": "VpnTunnel"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of VpnTunnel resources contained in the specified project and region.",
"httpMethod": "GET",
"id": "compute.vpnTunnels.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"region": {
"description": "Name of the region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/regions/{region}/vpnTunnels",
"response": {
"$ref": "VpnTunnelList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"zoneOperations": {
"methods": {
"delete": {
"description": "Deletes the specified zone-specific Operations resource.",
"httpMethod": "DELETE",
"id": "compute.zoneOperations.delete",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/operations/{operation}",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves the specified zone-specific Operations resource.",
"httpMethod": "GET",
"id": "compute.zoneOperations.get",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/operations/{operation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves a list of Operation resources contained within the specified zone.",
"httpMethod": "GET",
"id": "compute.zoneOperations.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/operations",
"response": {
"$ref": "OperationList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"wait": {
"description": "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.\n\nThis method is called on a best-effort basis. Specifically: \n- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. \n- 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`.",
"httpMethod": "POST",
"id": "compute.zoneOperations.wait",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}/operations/{operation}/wait",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"zones": {
"methods": {
"get": {
"description": "Returns the specified Zone resource. Gets a list of available zones by making a list() request.",
"httpMethod": "GET",
"id": "compute.zones.get",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone resource to return.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "{project}/zones/{zone}",
"response": {
"$ref": "Zone"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Retrieves the list of Zone resources available to the specified project.",
"httpMethod": "GET",
"id": "compute.zones.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "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 `=`, `!=`, `\u003e`, or `\u003c`.\n\nFor example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.\n\nYou can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.\n\nTo filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ```",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or `creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
}
},
"path": "{project}/zones",
"response": {
"$ref": "ZoneList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
}
},
"revision": "20200501",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
"description": "A specification of the type and number of accelerator cards attached to the instance.",
"id": "AcceleratorConfig",
"properties": {
"acceleratorCount": {
"description": "The number of the guest accelerator cards exposed to this instance.",
"format": "int32",
"type": "integer"
},
"acceleratorType": {
"description": "Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.",
"type": "string"
}
},
"type": "object"
},
"AcceleratorType": {
"description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that you can add to VM instances to improve or accelerate performance when working with intensive workloads. For more information, read GPUs on Compute Engine. (== resource_for {$api_version}.acceleratorTypes ==)",
"id": "AcceleratorType",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this accelerator type."
},
"description": {
"description": "[Output Only] An optional textual description of the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#acceleratorType",
"description": "[Output Only] The type of the resource. Always compute#acceleratorType for accelerator types.",
"type": "string"
},
"maximumCardsPerInstance": {
"description": "[Output Only] Maximum accelerator cards allowed per instance.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"zone": {
"description": "[Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"AcceleratorTypeAggregatedList": {
"id": "AcceleratorTypeAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "AcceleratorTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of accelerator types."
},
"description": "A list of AcceleratorTypesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#acceleratorTypeAggregatedList",
"description": "[Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AcceleratorTypeList": {
"description": "Contains a list of accelerator types.",
"id": "AcceleratorTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of AcceleratorType resources.",
"items": {
"$ref": "AcceleratorType"
},
"type": "array"
},
"kind": {
"default": "compute#acceleratorTypeList",
"description": "[Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AcceleratorTypesScopedList": {
"id": "AcceleratorTypesScopedList",
"properties": {
"acceleratorTypes": {
"description": "[Output Only] A list of accelerator types contained in this scope.",
"items": {
"$ref": "AcceleratorType"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that appears when the accelerator types list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AccessConfig": {
"description": "An access configuration attached to an instance's network interface. Only one access config per instance is supported.",
"id": "AccessConfig",
"properties": {
"kind": {
"default": "compute#accessConfig",
"description": "[Output Only] Type of the resource. Always compute#accessConfig for access configs.",
"type": "string"
},
"name": {
"description": "The name of this access configuration. The default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access.",
"type": "string"
},
"natIP": {
"description": "An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier.\n\nIf an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"publicPtrDomainName": {
"description": "The DNS domain name for the public PTR record. You can set this field only if the `setPublicPtr` field is enabled.",
"type": "string"
},
"setPublicPtr": {
"description": "Specifies whether a public DNS 'PTR' record should be created to map the external IP address of the instance to a DNS domain name.",
"type": "boolean"
},
"type": {
"default": "ONE_TO_ONE_NAT",
"description": "The type of configuration. The default and only option is ONE_TO_ONE_NAT.",
"enum": [
"ONE_TO_ONE_NAT"
],
"enumDescriptions": [
""
],
"type": "string"
}
},
"type": "object"
},
"Address": {
"description": "Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier.\n\nUse global internal addresses for reserved peering network range.\n\nUse regional external addresses for the following resources:\n\n- External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA)\n\nUse regional internal IP addresses for subnet IP ranges (primary and secondary). This includes:\n\n- Internal IP addresses for VM instances - Alias IP ranges of VM instances (/32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses\n\nFor more information, read reserved IP address.\n\n(== resource_for {$api_version}.addresses ==) (== resource_for {$api_version}.globalAddresses ==)",
"id": "Address",
"properties": {
"address": {
"description": "The static IP address represented by this resource.",
"type": "string"
},
"addressType": {
"description": "The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL.",
"enum": [
"EXTERNAL",
"INTERNAL",
"UNSPECIFIED_TYPE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"ipVersion": {
"description": "The IP version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address.",
"enum": [
"IPV4",
"IPV6",
"UNSPECIFIED_VERSION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#address",
"description": "[Output Only] Type of the resource. Always compute#address for addresses.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.addresses.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a network load balancer.\n\nIf this field is not specified, it is assumed to be PREMIUM.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"prefixLength": {
"description": "The prefix length if the resource reprensents an IP range.",
"format": "int32",
"type": "integer"
},
"purpose": {
"description": "The purpose of this resource, which can be one of the following values: \n- `GCE_ENDPOINT` for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources. \n- `DNS_RESOLVER` for a DNS resolver address in a subnetwork \n- `VPC_PEERING` for addresses that are reserved for VPC peer networks. \n- `NAT_AUTO` for addresses that are external IP addresses automatically reserved for Cloud NAT.",
"enum": [
"DNS_RESOLVER",
"GCE_ENDPOINT",
"NAT_AUTO",
"VPC_PEERING"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"region": {
"description": "[Output Only] The URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available.",
"enum": [
"IN_USE",
"RESERVED",
"RESERVING"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"subnetwork": {
"description": "The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose.",
"type": "string"
},
"users": {
"description": "[Output Only] The URLs of the resources that are using this address.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"AddressAggregatedList": {
"id": "AddressAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "AddressesScopedList",
"description": "[Output Only] Name of the scope containing this set of addresses."
},
"description": "A list of AddressesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#addressAggregatedList",
"description": "[Output Only] Type of resource. Always compute#addressAggregatedList for aggregated lists of addresses.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AddressList": {
"description": "Contains a list of addresses.",
"id": "AddressList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Address resources.",
"items": {
"$ref": "Address"
},
"type": "array"
},
"kind": {
"default": "compute#addressList",
"description": "[Output Only] Type of resource. Always compute#addressList for lists of addresses.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AddressesScopedList": {
"id": "AddressesScopedList",
"properties": {
"addresses": {
"description": "[Output Only] A list of addresses contained in this scope.",
"items": {
"$ref": "Address"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AliasIpRange": {
"description": "An alias IP range attached to an instance's network interface.",
"id": "AliasIpRange",
"properties": {
"ipCidrRange": {
"description": "The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).",
"type": "string"
},
"subnetworkRangeName": {
"description": "The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.",
"type": "string"
}
},
"type": "object"
},
"AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk": {
"id": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk",
"properties": {
"diskSizeGb": {
"description": "Specifies the size of the disk in base-2 GB.",
"format": "int64",
"type": "string"
},
"interface": {
"description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AllocationSpecificSKUAllocationReservedInstanceProperties": {
"description": "Properties of the SKU instances being reserved.",
"id": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"properties": {
"guestAccelerators": {
"description": "Specifies accelerator type and count.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"localSsds": {
"description": "Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.",
"items": {
"$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk"
},
"type": "array"
},
"machineType": {
"description": "Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.",
"type": "string"
},
"minCpuPlatform": {
"description": "Minimum cpu platform the reservation.",
"type": "string"
}
},
"type": "object"
},
"AllocationSpecificSKUReservation": {
"description": "This reservation type allows to pre allocate specific instance configuration.",
"id": "AllocationSpecificSKUReservation",
"properties": {
"count": {
"description": "Specifies the number of resources that are allocated.",
"format": "int64",
"type": "string"
},
"inUseCount": {
"description": "[Output Only] Indicates how many instances are in use.",
"format": "int64",
"type": "string"
},
"instanceProperties": {
"$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"description": "The instance properties for the reservation."
}
},
"type": "object"
},
"AttachedDisk": {
"description": "An instance-attached disk resource.",
"id": "AttachedDisk",
"properties": {
"autoDelete": {
"description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
"type": "boolean"
},
"boot": {
"description": "Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.",
"type": "boolean"
},
"deviceName": {
"description": "Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.\n\nIf not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.",
"type": "string"
},
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts or decrypts a disk using a customer-supplied encryption key.\n\nIf you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.\n\nIf you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.\n\nIf you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.\n\nInstance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group."
},
"diskSizeGb": {
"description": "The size of the disk in GB.",
"format": "int64",
"type": "string"
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"index": {
"description": "[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.",
"format": "int32",
"type": "integer"
},
"initializeParams": {
"$ref": "AttachedDiskInitializeParams",
"description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both."
},
"interface": {
"description": "Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#attachedDisk",
"description": "[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.",
"type": "string"
},
"licenses": {
"description": "[Output Only] Any valid publicly visible licenses.",
"items": {
"type": "string"
},
"type": "array"
},
"mode": {
"description": "The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.",
"enum": [
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"shieldedInstanceInitialState": {
"$ref": "InitialStateConfig",
"description": "[Output Only] shielded vm initial state stored on disk"
},
"source": {
"description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.\n\nIf desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.\n\nNote that for InstanceTemplate, specify the disk name, not the URL for the disk.",
"type": "string"
},
"type": {
"description": "Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.",
"enum": [
"PERSISTENT",
"SCRATCH"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AttachedDiskInitializeParams": {
"description": "[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property; you can only define one or the other, but not both.",
"id": "AttachedDiskInitializeParams",
"properties": {
"description": {
"description": "An optional description. Provide this property when creating the disk.",
"type": "string"
},
"diskName": {
"description": "Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.",
"type": "string"
},
"diskSizeGb": {
"description": "Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.",
"format": "int64",
"type": "string"
},
"diskType": {
"description": "Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nOther values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType \n- projects/project/zones/zone/diskTypes/diskType \n- zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.",
"type": "object"
},
"onUpdateAction": {
"description": "Specifies which action to take on instance update with this disk. Default is to use the existing disk.",
"enum": [
"RECREATE_DISK",
"RECREATE_DISK_IF_SOURCE_CHANGED",
"USE_EXISTING_DISK"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"resourcePolicies": {
"description": "Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceImage": {
"description": "The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\nglobal/images/family/my-image-family\n\n\nIf the source image is deleted later, this field will not be set.",
"type": "string"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.\n\nInstance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys."
},
"sourceSnapshot": {
"description": "The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD.\n\nTo create a disk with a snapshot that you created, specify the snapshot name in the following format:\nglobal/snapshots/my-backup\n\n\nIf the source snapshot is deleted later, this field will not be set.",
"type": "string"
},
"sourceSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source snapshot."
}
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n{ \"audit_configs\": [ { \"service\": \"allServices\" \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\", }, { \"log_type\": \"ADMIN_READ\", } ] }, { \"service\": \"sampleservice.googleapis.com\" \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"exemptedMembers": {
"description": "",
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions. Example:\n\n{ \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\", } ] }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].",
"items": {
"type": "string"
},
"type": "array"
},
"ignoreChildExemptions": {
"description": "",
"type": "boolean"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"ADMIN_READ",
"DATA_READ",
"DATA_WRITE",
"LOG_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AuthorizationLoggingOptions": {
"description": "Authorization-related information used by Cloud Audit Logging.",
"id": "AuthorizationLoggingOptions",
"properties": {
"permissionType": {
"description": "The type of the permission that was checked.",
"enum": [
"ADMIN_READ",
"ADMIN_WRITE",
"DATA_READ",
"DATA_WRITE",
"PERMISSION_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Autoscaler": {
"description": "Represents an Autoscaler resource.\n\nGoogle Compute Engine has two Autoscaler resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/autoscalers) * [Regional](/compute/docs/reference/rest/{$api_version}/regionAutoscalers)\n\nUse autoscalers to automatically add or delete instances from a managed instance group according to your defined autoscaling policy. For more information, read Autoscaling Groups of Instances.\n\nFor zonal managed instance groups resource, use the autoscaler resource.\n\nFor regional managed instance groups, use the regionAutoscalers resource. (== resource_for {$api_version}.autoscalers ==) (== resource_for {$api_version}.regionAutoscalers ==)",
"id": "Autoscaler",
"properties": {
"autoscalingPolicy": {
"$ref": "AutoscalingPolicy",
"description": "The configuration parameters for the autoscaling algorithm. You can define one or more of the policies for an autoscaler: cpuUtilization, customMetricUtilizations, and loadBalancingUtilization.\n\nIf none of these are specified, the default will be to autoscale based on cpuUtilization to 0.6 or 60%."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#autoscaler",
"description": "[Output Only] Type of the resource. Always compute#autoscaler for autoscalers.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.autoscalers.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"recommendedSize": {
"description": "[Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates recommended MIG size even when autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to the existing managed instance group or autoscaler did not generate its prediction.",
"format": "int32",
"type": "integer"
},
"region": {
"description": "[Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope).",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the autoscaler configuration. Current set of possible values: \n- PENDING: Autoscaler backend hasn't read new/updated configuration. \n- DELETING: Configuration is being deleted. \n- ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. \n- ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future.",
"enum": [
"ACTIVE",
"DELETING",
"ERROR",
"PENDING"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"statusDetails": {
"description": "[Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter.",
"items": {
"$ref": "AutoscalerStatusDetails"
},
"type": "array"
},
"target": {
"description": "URL of the managed instance group that this autoscaler will scale.",
"type": "string"
},
"zone": {
"description": "[Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope).",
"type": "string"
}
},
"type": "object"
},
"AutoscalerAggregatedList": {
"id": "AutoscalerAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "AutoscalersScopedList",
"description": "[Output Only] Name of the scope containing this set of autoscalers."
},
"description": "A list of AutoscalersScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#autoscalerAggregatedList",
"description": "[Output Only] Type of resource. Always compute#autoscalerAggregatedList for aggregated lists of autoscalers.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AutoscalerList": {
"description": "Contains a list of Autoscaler resources.",
"id": "AutoscalerList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Autoscaler resources.",
"items": {
"$ref": "Autoscaler"
},
"type": "array"
},
"kind": {
"default": "compute#autoscalerList",
"description": "[Output Only] Type of resource. Always compute#autoscalerList for lists of autoscalers.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AutoscalerStatusDetails": {
"id": "AutoscalerStatusDetails",
"properties": {
"message": {
"description": "The status message.",
"type": "string"
},
"type": {
"description": "The type of error, warning, or notice returned. Current set of possible values: \n- ALL_INSTANCES_UNHEALTHY (WARNING): All instances in the instance group are unhealthy (not in RUNNING state). \n- BACKEND_SERVICE_DOES_NOT_EXIST (ERROR): There is no backend service attached to the instance group. \n- CAPPED_AT_MAX_NUM_REPLICAS (WARNING): Autoscaler recommends a size greater than maxNumReplicas. \n- CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING): The custom metric samples are not exported often enough to be a credible base for autoscaling. \n- CUSTOM_METRIC_INVALID (ERROR): The custom metric that was specified does not exist or does not have the necessary labels. \n- MIN_EQUALS_MAX (WARNING): The minNumReplicas is equal to maxNumReplicas. This means the autoscaler cannot add or remove instances from the instance group. \n- MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING): The autoscaler did not receive any data from the custom metric configured for autoscaling. \n- MISSING_LOAD_BALANCING_DATA_POINTS (WARNING): The autoscaler is configured to scale based on a load balancing signal but the instance group has not received any requests from the load balancer. \n- MODE_OFF (WARNING): Autoscaling is turned off. The number of instances in the group won't change automatically. The autoscaling configuration is preserved. \n- MODE_ONLY_UP (WARNING): Autoscaling is in the \"Autoscale only up\" mode. The autoscaler can add instances but not remove any. \n- MORE_THAN_ONE_BACKEND_SERVICE (ERROR): The instance group cannot be autoscaled because it has more than one backend service attached to it. \n- NOT_ENOUGH_QUOTA_AVAILABLE (ERROR): There is insufficient quota for the necessary resources, such as CPU or number of instances. \n- REGION_RESOURCE_STOCKOUT (ERROR): Shown only for regional autoscalers: there is a resource stockout in the chosen region. \n- SCALING_TARGET_DOES_NOT_EXIST (ERROR): The target to be scaled does not exist. \n- UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION (ERROR): Autoscaling does not work with an HTTP/S load balancer that has been configured for maxRate. \n- ZONE_RESOURCE_STOCKOUT (ERROR): For zonal autoscalers: there is a resource stockout in the chosen zone. For regional autoscalers: in at least one of the zones you're using there is a resource stockout. New values might be added in the future. Some of the values might not be available in all API versions.",
"enum": [
"ALL_INSTANCES_UNHEALTHY",
"BACKEND_SERVICE_DOES_NOT_EXIST",
"CAPPED_AT_MAX_NUM_REPLICAS",
"CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE",
"CUSTOM_METRIC_INVALID",
"MIN_EQUALS_MAX",
"MISSING_CUSTOM_METRIC_DATA_POINTS",
"MISSING_LOAD_BALANCING_DATA_POINTS",
"MODE_OFF",
"MODE_ONLY_UP",
"MORE_THAN_ONE_BACKEND_SERVICE",
"NOT_ENOUGH_QUOTA_AVAILABLE",
"REGION_RESOURCE_STOCKOUT",
"SCALING_TARGET_DOES_NOT_EXIST",
"UNKNOWN",
"UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION",
"ZONE_RESOURCE_STOCKOUT"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AutoscalersScopedList": {
"id": "AutoscalersScopedList",
"properties": {
"autoscalers": {
"description": "[Output Only] A list of autoscalers contained in this scope.",
"items": {
"$ref": "Autoscaler"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of autoscalers when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"AutoscalingPolicy": {
"description": "Cloud Autoscaler policy.",
"id": "AutoscalingPolicy",
"properties": {
"coolDownPeriodSec": {
"description": "The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds.\n\nVirtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.",
"format": "int32",
"type": "integer"
},
"cpuUtilization": {
"$ref": "AutoscalingPolicyCpuUtilization",
"description": "Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group."
},
"customMetricUtilizations": {
"description": "Configuration parameters of autoscaling based on a custom metric.",
"items": {
"$ref": "AutoscalingPolicyCustomMetricUtilization"
},
"type": "array"
},
"loadBalancingUtilization": {
"$ref": "AutoscalingPolicyLoadBalancingUtilization",
"description": "Configuration parameters of autoscaling based on load balancer."
},
"maxNumReplicas": {
"description": "The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.",
"format": "int32",
"type": "integer"
},
"minNumReplicas": {
"description": "The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.",
"format": "int32",
"type": "integer"
},
"mode": {
"description": "Defines operating mode for this policy.",
"enum": [
"OFF",
"ON",
"ONLY_UP"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AutoscalingPolicyCpuUtilization": {
"description": "CPU utilization policy.",
"id": "AutoscalingPolicyCpuUtilization",
"properties": {
"utilizationTarget": {
"description": "The target CPU utilization that the autoscaler should maintain. Must be a float value in the range (0, 1]. If not specified, the default is 0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales down the number of instances until it reaches the minimum number of instances you specified or until the average CPU of your instances reaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler scales up until it reaches the maximum number of instances you specified or until the average utilization reaches the target utilization.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"AutoscalingPolicyCustomMetricUtilization": {
"description": "Custom utilization metric policy.",
"id": "AutoscalingPolicyCustomMetricUtilization",
"properties": {
"metric": {
"description": "The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values.\n\nThe metric must have a value type of INT64 or DOUBLE.",
"type": "string"
},
"utilizationTarget": {
"description": "The target value of the metric that autoscaler should maintain. This must be a positive value. A utilization metric scales number of virtual machines handling requests to increase or decrease proportionally to the metric.\n\nFor example, a good metric to use as a utilization_target is compute.googleapis.com/instance/network/received_bytes_count. The autoscaler will work to keep this value constant for each of the instances.",
"format": "double",
"type": "number"
},
"utilizationTargetType": {
"description": "Defines how target utilization value is expressed for a Stackdriver Monitoring metric. Either GAUGE, DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
"enum": [
"DELTA_PER_MINUTE",
"DELTA_PER_SECOND",
"GAUGE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AutoscalingPolicyLoadBalancingUtilization": {
"description": "Configuration parameters of autoscaling based on load balancing.",
"id": "AutoscalingPolicyLoadBalancingUtilization",
"properties": {
"utilizationTarget": {
"description": "Fraction of backend capacity utilization (set in HTTP(S) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Backend": {
"description": "Message containing information of one individual backend.",
"id": "Backend",
"properties": {
"balancingMode": {
"description": "Specifies the balancing mode for the backend.\n\nWhen choosing a balancing mode, you need to consider the loadBalancingScheme, and protocol for the backend service, as well as the type of backend (instance group or NEG).\n\n \n- If the load balancing mode is CONNECTION, then the load is spread based on how many concurrent connections the backend can handle.\nYou can use the CONNECTION balancing mode if the protocol for the backend service is SSL, TCP, or UDP.\n\nIf the loadBalancingScheme for the backend service is EXTERNAL (SSL Proxy and TCP Proxy load balancers), you must also specify exactly one of the following parameters: maxConnections (except for regional managed instance groups), maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nIf the loadBalancingScheme for the backend service is INTERNAL (internal TCP/UDP load balancers), you cannot specify any additional parameters.\n \n- If the load balancing mode is RATE, the load is spread based on the rate of HTTP requests per second (RPS).\nYou can use the RATE balancing mode if the protocol for the backend service is HTTP or HTTPS. You must specify exactly one of the following parameters: maxRate (except for regional managed instance groups), maxRatePerInstance, or maxRatePerEndpoint.\n \n- If the load balancing mode is UTILIZATION, the load is spread based on the backend utilization of instances in an instance group.\nYou can use the UTILIZATION balancing mode if the loadBalancingScheme of the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED and the backends are instance groups. There are no restrictions on the backend service protocol.",
"enum": [
"CONNECTION",
"RATE",
"UTILIZATION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"capacityScaler": {
"description": "A multiplier applied to the group's maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].\n\nThis cannot be used for internal load balancing.",
"format": "float",
"type": "number"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"failover": {
"description": "This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService.",
"type": "boolean"
},
"group": {
"description": "The fully-qualified URL of an instance group or network endpoint group (NEG) resource. The type of backend that a backend service supports depends on the backend service's loadBalancingScheme.\n\n \n- When the loadBalancingScheme for the backend service is EXTERNAL, INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, the backend can be either an instance group or a NEG. The backends on the backend service must be either all instance groups or all NEGs. You cannot mix instance group and NEG backends on the same backend service. \n\n\n- When the loadBalancingScheme for the backend service is INTERNAL, the backend must be an instance group in the same region as the backend service. NEGs are not supported. \n\nYou must use the fully-qualified URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported.",
"type": "string"
},
"maxConnections": {
"description": "Defines a target maximum number of simultaneous connections that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnectionsPerInstance, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. If the loadBalancingScheme is INTERNAL, then maxConnections is not supported, even though the backend requires a balancing mode of CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxConnectionsPerEndpoint": {
"description": "Defines a target maximum number of simultaneous connections for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a maximum number of target maximum simultaneous connections for the NEG. If the backend's balancingMode is CONNECTION, and the backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerInstance.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerEndpoint even though its backends require a balancing mode of CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxConnectionsPerInstance": {
"description": "Defines a target maximum number of simultaneous connections for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum number of simultaneous connections for the whole instance group. If the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is CONNECTION, and backend is attached to a backend service whose loadBalancingScheme is EXTERNAL, you must specify either this parameter, maxConnections, or maxConnectionsPerEndpoint.\n\nNot available if the backend's balancingMode is RATE. Internal TCP/UDP load balancing does not support setting maxConnectionsPerInstance even though its backends require a balancing mode of CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxRate": {
"description": "Defines a maximum number of HTTP requests per second (RPS) that the backend can handle. Valid for network endpoint group and instance group backends (except for regional managed instance groups). Must not be defined if the backend is a managed instance group that uses autoscaling based on load balancing.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify maxRate, maxRatePerInstance, or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxRatePerEndpoint": {
"description": "Defines a maximum target for requests per second (RPS) for an endpoint of a NEG. This is multiplied by the number of endpoints in the NEG to implicitly calculate a target maximum rate for the NEG.\n\nIf the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerInstance.\n\nNot available if the backend's balancingMode is CONNECTION.",
"format": "float",
"type": "number"
},
"maxRatePerInstance": {
"description": "Defines a maximum target for requests per second (RPS) for a single VM in a backend instance group. This is multiplied by the number of instances in the instance group to implicitly calculate a target maximum rate for the whole instance group.\n\nIf the backend's balancingMode is UTILIZATION, this is an optional parameter. If the backend's balancingMode is RATE, you must specify either this parameter, maxRate (except for regional managed instance groups), or maxRatePerEndpoint.\n\nNot available if the backend's balancingMode is CONNECTION.",
"format": "float",
"type": "number"
},
"maxUtilization": {
"description": "Defines the maximum average backend utilization of a backend VM in an instance group. The valid range is [0.0, 1.0]. This is an optional parameter if the backend's balancingMode is UTILIZATION.\n\nThis parameter can be used in conjunction with maxRate, maxRatePerInstance, maxConnections (except for regional managed instance groups), or maxConnectionsPerInstance.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendBucket": {
"description": "Represents a Cloud Storage Bucket resource.\n\nThis Cloud Storage bucket resource is referenced by a URL map of a load balancer. For more information, read Backend Buckets.",
"id": "BackendBucket",
"properties": {
"bucketName": {
"description": "Cloud Storage bucket name.",
"type": "string"
},
"cdnPolicy": {
"$ref": "BackendBucketCdnPolicy",
"description": "Cloud CDN configuration for this BackendBucket."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional textual description of the resource; provided by the client when the resource is created.",
"type": "string"
},
"enableCdn": {
"description": "If true, enable Cloud CDN for this BackendBucket.",
"type": "boolean"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#backendBucket",
"description": "Type of the resource.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
}
},
"type": "object"
},
"BackendBucketCdnPolicy": {
"description": "Message containing Cloud CDN configuration for a backend bucket.",
"id": "BackendBucketCdnPolicy",
"properties": {
"signedUrlCacheMaxAgeSec": {
"description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
"format": "int64",
"type": "string"
},
"signedUrlKeyNames": {
"description": "[Output Only] Names of the keys for signing request URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackendBucketList": {
"description": "Contains a list of BackendBucket resources.",
"id": "BackendBucketList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of BackendBucket resources.",
"items": {
"$ref": "BackendBucket"
},
"type": "array"
},
"kind": {
"default": "compute#backendBucketList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"BackendService": {
"description": "Represents a Backend Service resource.\n\nA backend service contains configuration values for Google Cloud Platform load balancing services.\n\nBackend services in Google Compute Engine can be either regionally or globally scoped.\n\n* [Global](/compute/docs/reference/rest/{$api_version}/backendServices) * [Regional](/compute/docs/reference/rest/{$api_version}/regionBackendServices)\n\nFor more information, read Backend Services.\n\n(== resource_for {$api_version}.backendService ==)",
"id": "BackendService",
"properties": {
"affinityCookieTtlSec": {
"description": "If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is one day (86,400).",
"format": "int32",
"type": "integer"
},
"backends": {
"description": "The list of backends that serve this BackendService.",
"items": {
"$ref": "Backend"
},
"type": "array"
},
"cdnPolicy": {
"$ref": "BackendServiceCdnPolicy",
"description": "Cloud CDN configuration for this BackendService."
},
"circuitBreakers": {
"$ref": "CircuitBreakers",
"description": "Settings controlling the volume of connections to a backend service. If not set, this feature is considered disabled.\n\nThis field is applicable to either: \n- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. \n- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
},
"connectionDraining": {
"$ref": "ConnectionDraining"
},
"consistentHash": {
"$ref": "ConsistentHashLoadBalancerSettings",
"description": "Consistent Hash-based load balancing can be used to provide soft session affinity based on HTTP headers, cookies or other properties. This load balancing policy is applicable only for HTTP connections. The affinity to a particular destination host will be lost when one or more hosts are added/removed from the destination service. This field specifies parameters that control consistent hashing. This field is only applicable when localityLbPolicy is set to MAGLEV or RING_HASH.\n\nThis field is applicable to either: \n- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. \n- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"customRequestHeaders": {
"description": "Headers that the HTTP/S load balancer should add to proxied requests.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"enableCDN": {
"description": "If true, enables Cloud CDN for the backend service. Only applicable if the loadBalancingScheme is EXTERNAL and the protocol is HTTP or HTTPS.",
"type": "boolean"
},
"failoverPolicy": {
"$ref": "BackendServiceFailoverPolicy",
"description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. Requires at least one backend instance group to be defined as a backup (failover) backend."
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a BackendService.",
"format": "byte",
"type": "string"
},
"healthChecks": {
"description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently at most one health check can be specified. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet NEG backends must not have a health check. A health check must",
"items": {
"type": "string"
},
"type": "array"
},
"iap": {
"$ref": "BackendServiceIAP"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#backendService",
"description": "[Output Only] Type of resource. Always compute#backendService for backend services.",
"type": "string"
},
"loadBalancingScheme": {
"description": "Specifies the load balancer type. Choose EXTERNAL for load balancers that receive traffic from external clients. Choose INTERNAL for Internal TCP/UDP Load Balancing. Choose INTERNAL_MANAGED for Internal HTTP(S) Load Balancing. Choose INTERNAL_SELF_MANAGED for Traffic Director. A backend service created for one type of load balancing cannot be used with another. For more information, refer to Choosing a load balancer.",
"enum": [
"EXTERNAL",
"INTERNAL",
"INTERNAL_MANAGED",
"INTERNAL_SELF_MANAGED",
"INVALID_LOAD_BALANCING_SCHEME"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"localityLbPolicy": {
"description": "The load balancing algorithm used within the scope of the locality. The possible values are: \n- ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. \n- LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. \n- RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. \n- RANDOM: The load balancer selects a random healthy host. \n- ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. \n- MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, refer to https://ai.google/research/pubs/pub44824 \n\nThis field is applicable to either: \n- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. \n- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. \n\nIf sessionAffinity is not NONE, and this field is not set to \u003eMAGLEV or RING_HASH, session affinity settings will not take effect.",
"enum": [
"INVALID_LB_POLICY",
"LEAST_REQUEST",
"MAGLEV",
"ORIGINAL_DESTINATION",
"RANDOM",
"RING_HASH",
"ROUND_ROBIN"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"logConfig": {
"$ref": "BackendServiceLogConfig",
"description": "This field denotes the logging options for the load balancer traffic served by this backend service. If logging is enabled, logs will be exported to Stackdriver."
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "The URL of the network to which this backend service belongs. This field can only be spcified when the load balancing scheme is set to INTERNAL.",
"type": "string"
},
"outlierDetection": {
"$ref": "OutlierDetection",
"description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. If not set, this feature is considered disabled.\n\nThis field is applicable to either: \n- A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. \n- A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED."
},
"port": {
"description": "Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80.\n\nThis cannot be used if the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "A named port on a backend instance group representing the port for communication to the backend VMs in that group. Required when the loadBalancingScheme is EXTERNAL, INTERNAL_MANAGED, or INTERNAL_SELF_MANAGED and the backends are instance groups. The named port must be defined on each backend instance group. This parameter has no meaning if the backends are NEGs.\n\n\n\nMust be omitted when the loadBalancingScheme is INTERNAL (Internal TCP/UDP Load Balancing).",
"type": "string"
},
"protocol": {
"description": "The protocol this BackendService uses to communicate with backends.\n\nPossible values are HTTP, HTTPS, HTTP2, TCP, SSL, or UDP. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancer or for Traffic Director for more information.",
"enum": [
"HTTP",
"HTTP2",
"HTTPS",
"SSL",
"TCP",
"UDP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"securityPolicy": {
"description": "[Output Only] The resource URL for the security policy associated with this backend service.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sessionAffinity": {
"description": "Type of session affinity to use. The default is NONE. Session affinity is not applicable if the --protocol is UDP.\n\nWhen the loadBalancingScheme is EXTERNAL, possible values are NONE, CLIENT_IP, or GENERATED_COOKIE. You can use GENERATED_COOKIE if the protocol is HTTP or HTTPS.\n\nWhen the loadBalancingScheme is INTERNAL, possible values are NONE, CLIENT_IP, CLIENT_IP_PROTO, or CLIENT_IP_PORT_PROTO.\n\nWhen the loadBalancingScheme is INTERNAL_SELF_MANAGED, or INTERNAL_MANAGED, possible values are NONE, CLIENT_IP, GENERATED_COOKIE, HEADER_FIELD, or HTTP_COOKIE.",
"enum": [
"CLIENT_IP",
"CLIENT_IP_PORT_PROTO",
"CLIENT_IP_PROTO",
"GENERATED_COOKIE",
"HEADER_FIELD",
"HTTP_COOKIE",
"NONE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"timeoutSec": {
"description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information read, Backend service settings The default is 30 seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"BackendServiceAggregatedList": {
"description": "Contains a list of BackendServicesScopedList.",
"id": "BackendServiceAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "BackendServicesScopedList",
"description": "Name of the scope containing this set of BackendServices."
},
"description": "A list of BackendServicesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#backendServiceAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"BackendServiceCdnPolicy": {
"description": "Message containing Cloud CDN configuration for a backend service.",
"id": "BackendServiceCdnPolicy",
"properties": {
"cacheKeyPolicy": {
"$ref": "CacheKeyPolicy",
"description": "The CacheKeyPolicy for this CdnPolicy."
},
"signedUrlCacheMaxAgeSec": {
"description": "Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. Defaults to 1hr (3600s). When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a \"Cache-Control: public, max-age=[TTL]\" header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.",
"format": "int64",
"type": "string"
},
"signedUrlKeyNames": {
"description": "[Output Only] Names of the keys for signing request URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackendServiceFailoverPolicy": {
"description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. On failover or failback, this field indicates whether connection draining will be honored. GCP has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes).",
"id": "BackendServiceFailoverPolicy",
"properties": {
"disableConnectionDrainOnFailover": {
"description": "This can be set to true only if the protocol is TCP.\n\nThe default is false.",
"type": "boolean"
},
"dropTrafficIfUnhealthy": {
"description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. If set to true, connections to the load balancer are dropped when all primary and all backup backend VMs are unhealthy. If set to false, connections are distributed among all primary VMs when all primary and all backup backend VMs are unhealthy.\n\nThe default is false.",
"type": "boolean"
},
"failoverRatio": {
"description": "Applicable only to Failover for Internal TCP/UDP Load Balancing. The value of the field must be in the range [0, 1]. If the value is 0, the load balancer performs a failover when the number of healthy primary VMs equals zero. For all other values, the load balancer performs a failover when the total number of healthy primary VMs is less than this ratio.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendServiceGroupHealth": {
"id": "BackendServiceGroupHealth",
"properties": {
"healthStatus": {
"description": "Health state of the backend instances or endpoints in requested instance or network endpoint group, determined based on configured health checks.",
"items": {
"$ref": "HealthStatus"
},
"type": "array"
},
"kind": {
"default": "compute#backendServiceGroupHealth",
"description": "[Output Only] Type of resource. Always compute#backendServiceGroupHealth for the health of backend services.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceIAP": {
"description": "Identity-Aware Proxy",
"id": "BackendServiceIAP",
"properties": {
"enabled": {
"type": "boolean"
},
"oauth2ClientId": {
"type": "string"
},
"oauth2ClientSecret": {
"type": "string"
},
"oauth2ClientSecretSha256": {
"description": "[Output Only] SHA256 hash value for the field oauth2_client_secret above.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceList": {
"description": "Contains a list of BackendService resources.",
"id": "BackendServiceList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of BackendService resources.",
"items": {
"$ref": "BackendService"
},
"type": "array"
},
"kind": {
"default": "compute#backendServiceList",
"description": "[Output Only] Type of resource. Always compute#backendServiceList for lists of backend services.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"BackendServiceLogConfig": {
"description": "The available logging options for the load balancer traffic served by this backend service.",
"id": "BackendServiceLogConfig",
"properties": {
"enable": {
"description": "This field denotes whether to enable logging for the load balancer traffic served by this backend service.",
"type": "boolean"
},
"sampleRate": {
"description": "This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendServiceReference": {
"id": "BackendServiceReference",
"properties": {
"backendService": {
"type": "string"
}
},
"type": "object"
},
"BackendServicesScopedList": {
"id": "BackendServicesScopedList",
"properties": {
"backendServices": {
"description": "A list of BackendServices contained in this scope.",
"items": {
"$ref": "BackendService"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members` with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.\n\nIf the condition evaluates to `true`, then this binding applies to the current request.\n\nIf the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .\n\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.\n\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
}
},
"type": "object"
},
"CacheInvalidationRule": {
"id": "CacheInvalidationRule",
"properties": {
"host": {
"description": "If set, this invalidation rule will only apply to requests with a Host header matching host.",
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
"CacheKeyPolicy": {
"description": "Message containing what to include in the cache key for a request for Cloud CDN.",
"id": "CacheKeyPolicy",
"properties": {
"includeHost": {
"description": "If true, requests to different hosts will be cached separately.",
"type": "boolean"
},
"includeProtocol": {
"description": "If true, http and https requests will be cached separately.",
"type": "boolean"
},
"includeQueryString": {
"description": "If true, include query string parameters in the cache key according to query_string_whitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.",
"type": "boolean"
},
"queryStringBlacklist": {
"description": "Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify query_string_whitelist or query_string_blacklist, not both. '\u0026' and '=' will be percent encoded and not treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
},
"queryStringWhitelist": {
"description": "Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify query_string_whitelist or query_string_blacklist, not both. '\u0026' and '=' will be percent encoded and not treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CircuitBreakers": {
"description": "Settings controlling the volume of connections to a backend service.",
"id": "CircuitBreakers",
"properties": {
"maxConnections": {
"description": "The maximum number of connections to the backend service. If not specified, there is no limit.",
"format": "int32",
"type": "integer"
},
"maxPendingRequests": {
"description": "The maximum number of pending requests allowed to the backend service. If not specified, there is no limit.",
"format": "int32",
"type": "integer"
},
"maxRequests": {
"description": "The maximum number of parallel requests that allowed to the backend service. If not specified, there is no limit.",
"format": "int32",
"type": "integer"
},
"maxRequestsPerConnection": {
"description": "Maximum requests for a single connection to the backend service. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.",
"format": "int32",
"type": "integer"
},
"maxRetries": {
"description": "The maximum number of parallel retries allowed to the backend cluster. If not specified, the default is 1.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Commitment": {
"description": "Represents a regional Commitment resource.\n\nCreating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)",
"id": "Commitment",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"endTimestamp": {
"description": "[Output Only] Commitment end time in RFC3339 text format.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#commitment",
"description": "[Output Only] Type of the resource. Always compute#commitment for commitments.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"plan": {
"description": "The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).",
"enum": [
"INVALID",
"THIRTY_SIX_MONTH",
"TWELVE_MONTH"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where this commitment may be used.",
"type": "string"
},
"reservations": {
"description": "List of reservations in this commitment.",
"items": {
"$ref": "Reservation"
},
"type": "array"
},
"resources": {
"description": "A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.",
"items": {
"$ref": "ResourceCommitment"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"startTimestamp": {
"description": "[Output Only] Commitment start time in RFC3339 text format.",
"type": "string"
},
"status": {
"description": "[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.",
"enum": [
"ACTIVE",
"CREATING",
"EXPIRED",
"NOT_YET_ACTIVE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"statusMessage": {
"description": "[Output Only] An optional, human-readable explanation of the status.",
"type": "string"
}
},
"type": "object"
},
"CommitmentAggregatedList": {
"id": "CommitmentAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "CommitmentsScopedList",
"description": "[Output Only] Name of the scope containing this set of commitments."
},
"description": "A list of CommitmentsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#commitmentAggregatedList",
"description": "[Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"CommitmentList": {
"description": "Contains a list of Commitment resources.",
"id": "CommitmentList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Commitment resources.",
"items": {
"$ref": "Commitment"
},
"type": "array"
},
"kind": {
"default": "compute#commitmentList",
"description": "[Output Only] Type of resource. Always compute#commitmentList for lists of commitments.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"CommitmentsScopedList": {
"id": "CommitmentsScopedList",
"properties": {
"commitments": {
"description": "[Output Only] A list of commitments contained in this scope.",
"items": {
"$ref": "Commitment"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of commitments when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Condition": {
"description": "A condition to be met.",
"id": "Condition",
"properties": {
"iam": {
"description": "Trusted attributes supplied by the IAM system.",
"enum": [
"APPROVER",
"ATTRIBUTION",
"AUTHORITY",
"CREDENTIALS_TYPE",
"JUSTIFICATION_TYPE",
"NO_ATTR",
"SECURITY_REALM"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"op": {
"description": "An operator to apply the subject with.",
"enum": [
"DISCHARGED",
"EQUALS",
"IN",
"NOT_EQUALS",
"NOT_IN",
"NO_OP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"svc": {
"description": "Trusted attributes discharged by the service.",
"type": "string"
},
"sys": {
"description": "Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.",
"enum": [
"IP",
"NAME",
"NO_ATTR",
"REGION",
"SERVICE"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"values": {
"description": "The objects of the condition.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ConnectionDraining": {
"description": "Message containing connection draining configuration.",
"id": "ConnectionDraining",
"properties": {
"drainingTimeoutSec": {
"description": "The amount of time in seconds to allow existing connections to persist while on unhealthy backend VMs. Only applicable if the protocol is not UDP. The valid range is [0, 3600].",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ConsistentHashLoadBalancerSettings": {
"description": "This message defines settings for a consistent hash style load balancer.",
"id": "ConsistentHashLoadBalancerSettings",
"properties": {
"httpCookie": {
"$ref": "ConsistentHashLoadBalancerSettingsHttpCookie",
"description": "Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE."
},
"httpHeaderName": {
"description": "The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.",
"type": "string"
},
"minimumRingSize": {
"description": "The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ConsistentHashLoadBalancerSettingsHttpCookie": {
"description": "The information about the HTTP Cookie on which the hash function is based for load balancing policies that use a consistent hash.",
"id": "ConsistentHashLoadBalancerSettingsHttpCookie",
"properties": {
"name": {
"description": "Name of the cookie.",
"type": "string"
},
"path": {
"description": "Path to set for the cookie.",
"type": "string"
},
"ttl": {
"$ref": "Duration",
"description": "Lifetime of the cookie."
}
},
"type": "object"
},
"CorsPolicy": {
"description": "The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing",
"id": "CorsPolicy",
"properties": {
"allowCredentials": {
"description": "In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access-Control-Allow-Credentials header.\nDefault is false.",
"type": "boolean"
},
"allowHeaders": {
"description": "Specifies the content for the Access-Control-Allow-Headers header.",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"description": "Specifies the content for the Access-Control-Allow-Methods header.",
"items": {
"type": "string"
},
"type": "array"
},
"allowOriginRegexes": {
"description": "Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript \nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigins": {
"description": "Specifies the list of origins that will be allowed to do CORS requests.\nAn origin is allowed if it matches either an item in allowOrigins or an item in allowOriginRegexes.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "If true, specifies the CORS policy is disabled. The default value of false, which indicates that the CORS policy is in effect.",
"type": "boolean"
},
"exposeHeaders": {
"description": "Specifies the content for the Access-Control-Expose-Headers header.",
"items": {
"type": "string"
},
"type": "array"
},
"maxAge": {
"description": "Specifies how long results of a preflight request can be cached in seconds. This translates to the Access-Control-Max-Age header.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CustomerEncryptionKey": {
"description": "Represents a customer-supplied encryption key",
"id": "CustomerEncryptionKey",
"properties": {
"kmsKeyName": {
"description": "The name of the encryption key that is stored in Google Cloud KMS.",
"type": "string"
},
"kmsKeyServiceAccount": {
"description": "The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used.",
"type": "string"
},
"rawKey": {
"description": "Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.",
"type": "string"
},
"sha256": {
"description": "[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.",
"type": "string"
}
},
"type": "object"
},
"CustomerEncryptionKeyProtectedDisk": {
"id": "CustomerEncryptionKeyProtectedDisk",
"properties": {
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Decrypts data associated with the disk with a customer-supplied encryption key."
},
"source": {
"description": "Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.",
"type": "string"
}
},
"type": "object"
},
"DeprecationStatus": {
"description": "Deprecation status for a public resource.",
"id": "DeprecationStatus",
"properties": {
"deleted": {
"description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.",
"type": "string"
},
"deprecated": {
"description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.",
"type": "string"
},
"obsolete": {
"description": "An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.",
"type": "string"
},
"replacement": {
"description": "The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.",
"type": "string"
},
"state": {
"description": "The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.",
"enum": [
"ACTIVE",
"DELETED",
"DEPRECATED",
"OBSOLETE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Disk": {
"description": "Represents a Persistent Disk resource.\n\nGoogle Compute Engine has two Disk resources:\n\n* [Zonal](/compute/docs/reference/rest/{$api_version}/disks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionDisks)\n\nPersistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options.\n\nThe disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks.\n\nThe regionDisks resource represents a regional persistent disk. For more information, read Regional resources. (== resource_for {$api_version}.disks ==) (== resource_for {$api_version}.regionDisks ==)",
"id": "Disk",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the disk using a customer-supplied encryption key.\n\nAfter you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine).\n\nCustomer-supplied encryption keys do not protect access to metadata of the disk.\n\nIf you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later."
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#disk",
"description": "[Output Only] Type of the resource. Always compute#disk for disks.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a disk.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this disk. These can be later modified by the setLabels method.",
"type": "object"
},
"lastAttachTimestamp": {
"description": "[Output Only] Last attach timestamp in RFC3339 text format.",
"type": "string"
},
"lastDetachTimestamp": {
"description": "[Output Only] Last detach timestamp in RFC3339 text format.",
"type": "string"
},
"licenseCodes": {
"description": "Integer license codes indicating which licenses are attached to this disk.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"licenses": {
"description": "A list of publicly visible licenses. Reserved for Google's use.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.disks.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"options": {
"description": "Internal use only.",
"type": "string"
},
"physicalBlockSizeBytes": {
"description": "Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.",
"format": "int64",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"replicaZones": {
"description": "URLs of the zones where the disk should be replicated to. Only applicable for regional resources.",
"items": {
"type": "string"
},
"type": "array"
},
"resourcePolicies": {
"description": "Resource policies applied to this disk for automatic snapshot creations.",
"items": {
"type": "string"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"sizeGb": {
"description": "Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.\n\nIf you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive.",
"format": "int64",
"type": "string"
},
"sourceImage": {
"description": "The source image used to create this disk. If the source image is deleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image:\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the image name in the following format:\nglobal/images/my-custom-image\n\n\nYou can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:\nglobal/images/family/my-image-family",
"type": "string"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key."
},
"sourceImageId": {
"description": "[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.",
"type": "string"
},
"sourceSnapshot": {
"description": "The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot \n- projects/project/global/snapshots/snapshot \n- global/snapshots/snapshot",
"type": "string"
},
"sourceSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key."
},
"sourceSnapshotId": {
"description": "[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of disk creation. CREATING: Disk is provisioning. RESTORING: Source data is being copied into the disk. FAILED: Disk creation failed. READY: Disk is ready for use. DELETING: Disk is deleting.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"RESTORING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"type": {
"description": "URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd",
"type": "string"
},
"users": {
"description": "[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance",
"items": {
"type": "string"
},
"type": "array"
},
"zone": {
"description": "[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"DiskAggregatedList": {
"id": "DiskAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "DisksScopedList",
"description": "[Output Only] Name of the scope containing this set of disks."
},
"description": "A list of DisksScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#diskAggregatedList",
"description": "[Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DiskInstantiationConfig": {
"description": "A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.",
"id": "DiskInstantiationConfig",
"properties": {
"autoDelete": {
"description": "Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).",
"type": "boolean"
},
"customImage": {
"description": "The custom source image to be used to restore this disk when instantiating this instance template.",
"type": "string"
},
"deviceName": {
"description": "Specifies the device name of the disk to which the configurations apply to.",
"type": "string"
},
"instantiateFrom": {
"description": "Specifies whether to include the disk and what image to use. Possible values are: \n- source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. \n- source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. \n- custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. \n- attach-read-only: to attach a read-only disk. Applicable to read-only disks. \n- do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.",
"enum": [
"ATTACH_READ_ONLY",
"BLANK",
"CUSTOM_IMAGE",
"DEFAULT",
"DO_NOT_INCLUDE",
"SOURCE_IMAGE",
"SOURCE_IMAGE_FAMILY"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"DiskList": {
"description": "A list of Disk resources.",
"id": "DiskList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Disk resources.",
"items": {
"$ref": "Disk"
},
"type": "array"
},
"kind": {
"default": "compute#diskList",
"description": "[Output Only] Type of resource. Always compute#diskList for lists of disks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DiskMoveRequest": {
"id": "DiskMoveRequest",
"properties": {
"destinationZone": {
"description": "The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone",
"type": "string"
},
"targetDisk": {
"description": "The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk",
"type": "string"
}
},
"type": "object"
},
"DiskType": {
"description": "Represents a Disk Type resource.\n\nGoogle Compute Engine has two Disk Type resources:\n\n* [Regional](/compute/docs/reference/rest/{$api_version}/regionDiskTypes) * [Zonal](/compute/docs/reference/rest/{$api_version}/diskTypes)\n\nYou can choose from a variety of disk types based on your needs. For more information, read Storage options.\n\nThe diskTypes resource represents disk types for a zonal persistent disk. For more information, read Zonal persistent disks.\n\nThe regionDiskTypes resource represents disk types for a regional persistent disk. For more information, read Regional persistent disks. (== resource_for {$api_version}.diskTypes ==) (== resource_for {$api_version}.regionDiskTypes ==)",
"id": "DiskType",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultDiskSizeGb": {
"description": "[Output Only] Server-defined default disk size in GB.",
"format": "int64",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this disk type."
},
"description": {
"description": "[Output Only] An optional description of this resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#diskType",
"description": "[Output Only] Type of the resource. Always compute#diskType for disk types.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"validDiskSize": {
"description": "[Output Only] An optional textual description of the valid disk size, such as \"10GB-10TB\".",
"type": "string"
},
"zone": {
"description": "[Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"DiskTypeAggregatedList": {
"id": "DiskTypeAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "DiskTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of disk types."
},
"description": "A list of DiskTypesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#diskTypeAggregatedList",
"description": "[Output Only] Type of resource. Always compute#diskTypeAggregatedList.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DiskTypeList": {
"description": "Contains a list of disk types.",
"id": "DiskTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of DiskType resources.",
"items": {
"$ref": "DiskType"
},
"type": "array"
},
"kind": {
"default": "compute#diskTypeList",
"description": "[Output Only] Type of resource. Always compute#diskTypeList for disk types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DiskTypesScopedList": {
"id": "DiskTypesScopedList",
"properties": {
"diskTypes": {
"description": "[Output Only] A list of disk types contained in this scope.",
"items": {
"$ref": "DiskType"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of disk types when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DisksAddResourcePoliciesRequest": {
"id": "DisksAddResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be added to this disk. Currently you can only specify one policy here.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DisksRemoveResourcePoliciesRequest": {
"id": "DisksRemoveResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be removed from this disk.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"DisksResizeRequest": {
"id": "DisksResizeRequest",
"properties": {
"sizeGb": {
"description": "The new size of the persistent disk, which is specified in GB.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"DisksScopedList": {
"id": "DisksScopedList",
"properties": {
"disks": {
"description": "[Output Only] A list of disks contained in this scope.",
"items": {
"$ref": "Disk"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of disks when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"DisplayDevice": {
"description": "A set of Display Device options",
"id": "DisplayDevice",
"properties": {
"enableDisplay": {
"description": "Defines whether the instance has Display enabled.",
"type": "boolean"
}
},
"type": "object"
},
"DistributionPolicy": {
"id": "DistributionPolicy",
"properties": {
"zones": {
"description": "Zones where the regional managed instance group will create and manage instances.",
"items": {
"$ref": "DistributionPolicyZoneConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"DistributionPolicyZoneConfiguration": {
"id": "DistributionPolicyZoneConfiguration",
"properties": {
"zone": {
"annotations": {
"required": [
"compute.regionInstanceGroupManagers.insert"
]
},
"description": "The URL of the zone. The zone must exist in the region where the managed instance group is located.",
"type": "string"
}
},
"type": "object"
},
"Duration": {
"description": "A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". Range is approximately 10,000 years.",
"id": "Duration",
"properties": {
"nanos": {
"description": "Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ExchangedPeeringRoute": {
"id": "ExchangedPeeringRoute",
"properties": {
"destRange": {
"description": "The destination range of the route.",
"type": "string"
},
"imported": {
"description": "True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict.",
"type": "boolean"
},
"nextHopRegion": {
"description": "The region of peering route next hop, only applies to dynamic routes.",
"type": "string"
},
"priority": {
"description": "The priority of the peering route.",
"format": "uint32",
"type": "integer"
},
"type": {
"description": "The type of the peering route.",
"enum": [
"DYNAMIC_PEERING_ROUTE",
"STATIC_PEERING_ROUTE",
"SUBNET_PEERING_ROUTE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ExchangedPeeringRoutesList": {
"id": "ExchangedPeeringRoutesList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of ExchangedPeeringRoute resources.",
"items": {
"$ref": "ExchangedPeeringRoute"
},
"type": "array"
},
"kind": {
"default": "compute#exchangedPeeringRoutesList",
"description": "[Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\ntitle: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\"\n\nExample (Equality):\n\ntitle: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\ntitle: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' \u0026\u0026 document.type != 'internal'\"\n\nExample (Data Manipulation):\n\ntitle: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.",
"type": "string"
}
},
"type": "object"
},
"ExternalVpnGateway": {
"description": "Represents an external VPN gateway.\n\nExternal VPN gateway is the on-premises VPN gateway(s) or another cloud provider's VPN gateway that connects to your Google Cloud VPN gateway.\n\nTo create a highly available VPN from Google Cloud Platform to your VPN gateway or another cloud provider's VPN gateway, you must create a external VPN gateway resource with information about the other gateway.\n\nFor more information about using external VPN gateways, see Creating an HA VPN gateway and tunnel pair to a peer VPN. (== resource_for {$api_version}.externalVpnGateways ==)",
"id": "ExternalVpnGateway",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"interfaces": {
"description": "List of interfaces for this external VPN gateway.",
"items": {
"$ref": "ExternalVpnGatewayInterface"
},
"type": "array"
},
"kind": {
"default": "compute#externalVpnGateway",
"description": "[Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.externalVpnGateways.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"redundancyType": {
"description": "Indicates the user-supplied redundancy type of this external VPN gateway.",
"enum": [
"FOUR_IPS_REDUNDANCY",
"SINGLE_IP_INTERNALLY_REDUNDANT",
"TWO_IPS_REDUNDANCY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
}
},
"type": "object"
},
"ExternalVpnGatewayInterface": {
"description": "The interface for the external VPN gateway.",
"id": "ExternalVpnGatewayInterface",
"properties": {
"id": {
"description": "The numeric ID of this interface. The allowed input values for this id for different redundancy types of external VPN gateway: SINGLE_IP_INTERNALLY_REDUNDANT - 0 TWO_IPS_REDUNDANCY - 0, 1 FOUR_IPS_REDUNDANCY - 0, 1, 2, 3",
"format": "uint32",
"type": "integer"
},
"ipAddress": {
"description": "IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider's VPN gateway, it cannot be an IP address from Google Compute Engine.",
"type": "string"
}
},
"type": "object"
},
"ExternalVpnGatewayList": {
"description": "Response to the list request, and contains a list of externalVpnGateways.",
"id": "ExternalVpnGatewayList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of ExternalVpnGateway resources.",
"items": {
"$ref": "ExternalVpnGateway"
},
"type": "array"
},
"kind": {
"default": "compute#externalVpnGatewayList",
"description": "[Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"FileContentBuffer": {
"id": "FileContentBuffer",
"properties": {
"content": {
"description": "The raw content in the secure keys file.",
"format": "byte",
"type": "string"
},
"fileType": {
"description": "The file type of source file.",
"enum": [
"BIN",
"UNDEFINED",
"X509"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Firewall": {
"description": "Represents a Firewall Rule resource.\n\nFirewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules.",
"id": "Firewall",
"properties": {
"allowed": {
"description": "The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection.",
"items": {
"properties": {
"IPProtocol": {
"description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.",
"type": "string"
},
"ports": {
"description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"denied": {
"description": "The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection.",
"items": {
"properties": {
"IPProtocol": {
"description": "The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number.",
"type": "string"
},
"ports": {
"description": "An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port.\n\nExample inputs include: [\"22\"], [\"80\",\"443\"], and [\"12345-12349\"].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this field when you create the resource.",
"type": "string"
},
"destinationRanges": {
"description": "If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported.",
"items": {
"type": "string"
},
"type": "array"
},
"direction": {
"description": "Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields.",
"enum": [
"EGRESS",
"INGRESS"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"disabled": {
"description": "Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled.",
"type": "boolean"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#firewall",
"description": "[Output Only] Type of the resource. Always compute#firewall for firewall rules.",
"type": "string"
},
"logConfig": {
"$ref": "FirewallLogConfig",
"description": "This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver."
},
"name": {
"annotations": {
"required": [
"compute.firewalls.insert",
"compute.firewalls.patch"
]
},
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used:\nglobal/networks/default\nIf you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network \n- projects/myproject/global/networks/my-network \n- global/networks/default",
"type": "string"
},
"priority": {
"description": "Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sourceRanges": {
"description": "If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceServiceAccounts": {
"description": "If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceTags": {
"description": "If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply.",
"items": {
"type": "string"
},
"type": "array"
},
"targetServiceAccounts": {
"description": "A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network.",
"items": {
"type": "string"
},
"type": "array"
},
"targetTags": {
"description": "A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FirewallList": {
"description": "Contains a list of firewalls.",
"id": "FirewallList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Firewall resources.",
"items": {
"$ref": "Firewall"
},
"type": "array"
},
"kind": {
"default": "compute#firewallList",
"description": "[Output Only] Type of resource. Always compute#firewallList for lists of firewalls.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"FirewallLogConfig": {
"description": "The available logging options for a firewall rule.",
"id": "FirewallLogConfig",
"properties": {
"enable": {
"description": "This field denotes whether to enable logging for a particular firewall rule.",
"type": "boolean"
}
},
"type": "object"
},
"FixedOrPercent": {
"description": "Encapsulates numeric value that can be either absolute or relative.",
"id": "FixedOrPercent",
"properties": {
"calculated": {
"description": "[Output Only] Absolute value of VM instances calculated based on the specific mode.\n\n \n- If the value is fixed, then the calculated value is equal to the fixed value. \n- If the value is a percent, then the calculated value is percent/100 * targetSize. For example, the calculated value of a 80% of a managed instance group with 150 instances would be (80/100 * 150) = 120 VM instances. If there is a remainder, the number is rounded up.",
"format": "int32",
"type": "integer"
},
"fixed": {
"description": "Specifies a fixed number of VM instances. This must be a positive integer.",
"format": "int32",
"type": "integer"
},
"percent": {
"description": "Specifies a percentage of instances between 0 to 100%, inclusive. For example, specify 80 for 80%.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ForwardingRule": {
"description": "Represents a Forwarding Rule resource.\n\nForwarding rule resources in GCP can be either regional or global in scope:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/globalForwardingRules) * [Regional](/compute/docs/reference/rest/{$api_version}/forwardingRules)\n\nA forwarding rule and its corresponding IP address represent the frontend configuration of a Google Cloud Platform load balancer. Forwarding rules can also reference target instances and Cloud VPN Classic gateways (targetVpnGateway).\n\nFor more information, read Forwarding rule concepts and Using protocol forwarding.\n\n(== resource_for {$api_version}.forwardingRules ==) (== resource_for {$api_version}.globalForwardingRules ==) (== resource_for {$api_version}.regionForwardingRules ==)",
"id": "ForwardingRule",
"properties": {
"IPAddress": {
"description": "IP address that this forwarding rule serves. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the target that you specify in the forwarding rule.\n\nIf you don't specify a reserved IP address, an ephemeral IP address is assigned. Methods for specifying an IP address:\n\n* IPv4 dotted decimal, as in `100.1.2.3` * Full URL, as in https://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name * Partial URL or by name, as in: * projects/project_id/regions/region/addresses/address-name * regions/region/addresses/address-name * global/addresses/address-name * address-name \n\nThe loadBalancingScheme and the forwarding rule's target determine the type of IP address that you can use. For detailed information, refer to [IP address specifications](/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).",
"type": "string"
},
"IPProtocol": {
"description": "The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP or ICMP.\n\nFor Internal TCP/UDP Load Balancing, the load balancing scheme is INTERNAL, and one of TCP or UDP are valid. For Traffic Director, the load balancing scheme is INTERNAL_SELF_MANAGED, and only TCPis valid. For Internal HTTP(S) Load Balancing, the load balancing scheme is INTERNAL_MANAGED, and only TCP is valid. For HTTP(S), SSL Proxy, and TCP Proxy Load Balancing, the load balancing scheme is EXTERNAL and only TCP is valid. For Network TCP/UDP Load Balancing, the load balancing scheme is EXTERNAL, and one of TCP or UDP is valid.",
"enum": [
"AH",
"ESP",
"ICMP",
"SCTP",
"TCP",
"UDP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"allPorts": {
"description": "This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. This field cannot be used with port or portRange fields.\n\nWhen the load balancing scheme is INTERNAL and protocol is TCP/UDP, specify this field to allow packets addressed to any ports will be forwarded to the backends configured with this forwarding rule.",
"type": "boolean"
},
"allowGlobalAccess": {
"description": "This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If the field is set to TRUE, clients can access ILB from all regions. Otherwise only allows access from clients in the same region as the internal load balancer.",
"type": "boolean"
},
"backendService": {
"description": "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the BackendService resource to receive the matched traffic.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request.\n\nTo see the latest fingerprint, make a get() request to retrieve a ForwardingRule.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"ipVersion": {
"description": "The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. This can only be specified for an external global forwarding rule.",
"enum": [
"IPV4",
"IPV6",
"UNSPECIFIED_VERSION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"isMirroringCollector": {
"description": "Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL.",
"type": "boolean"
},
"kind": {
"default": "compute#forwardingRule",
"description": "[Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources.",
"type": "string"
},
"loadBalancingScheme": {
"description": "Specifies the forwarding rule type.\n\n \n- EXTERNAL is used for: \n- Classic Cloud VPN gateways \n- Protocol forwarding to VMs from an external IP address \n- The following load balancers: HTTP(S), SSL Proxy, TCP Proxy, and Network TCP/UDP \n- INTERNAL is used for: \n- Protocol forwarding to VMs from an internal IP address \n- Internal TCP/UDP load balancers \n- INTERNAL_MANAGED is used for: \n- Internal HTTP(S) load balancers \n- INTERNAL_SELF_MANAGED is used for: \n- Traffic Director \n\nFor more information about forwarding rules, refer to Forwarding rule concepts.",
"enum": [
"EXTERNAL",
"INTERNAL",
"INTERNAL_MANAGED",
"INTERNAL_SELF_MANAGED",
"INVALID"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"metadataFilters": {
"description": "Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule will not be visible to those proxies.\nFor each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.\nmetadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references.\nmetadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
"items": {
"$ref": "MetadataFilter"
},
"type": "array"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "This field is not used for external load balancing.\n\nFor INTERNAL and INTERNAL_SELF_MANAGED load balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If this field is not specified, the default network will be used.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD.\n\nFor regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM.\n\nIf this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"portRange": {
"description": "When the load balancing scheme is EXTERNAL, INTERNAL_SELF_MANAGED and INTERNAL_MANAGED, you can specify a port_range. Use with a forwarding rule that points to a target proxy or a target pool. Do not use with a forwarding rule that points to a backend service. This field is used along with the target field for TargetHttpProxy, TargetHttpsProxy, TargetSslProxy, TargetTcpProxy, TargetVpnGateway, TargetPool, TargetInstance.\n\nApplicable only when IPProtocol is TCP, UDP, or SCTP, only packets addressed to ports in the specified range will be forwarded to target. Forwarding rules with the same [IPAddress, IPProtocol] pair must have disjoint port ranges.\n\nSome types of forwarding target have constraints on the acceptable ports: \n- TargetHttpProxy: 80, 8080 \n- TargetHttpsProxy: 443 \n- TargetTcpProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetSslProxy: 25, 43, 110, 143, 195, 443, 465, 587, 700, 993, 995, 1688, 1883, 5222 \n- TargetVpnGateway: 500, 4500",
"type": "string"
},
"ports": {
"description": "This field is used along with the backend_service field for internal load balancing.\n\nWhen the load balancing scheme is INTERNAL, a list of ports can be configured, for example, ['80'], ['8000','9000']. Only packets addressed to these ports are forwarded to the backends configured with the forwarding rule.\n\nIf the forwarding rule's loadBalancingScheme is INTERNAL, you can specify ports in one of the following ways:\n\n* A list of up to five ports, which can be non-contiguous * Keyword ALL, which causes the forwarding rule to forward traffic on any port of the forwarding rule's protocol.",
"items": {
"type": "string"
},
"type": "array"
},
"region": {
"description": "[Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"serviceLabel": {
"description": "An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name.\n\nThe label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.\n\nThis field is only used for internal load balancing.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"serviceName": {
"description": "[Output Only] The internal fully qualified service name for this Forwarding Rule.\n\nThis field is only used for internal load balancing.",
"type": "string"
},
"subnetwork": {
"description": "This field is only used for INTERNAL load balancing.\n\nFor internal load balancing, this field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule.\n\nIf the network specified is in auto subnet mode, this field is optional. However, if the network is in custom subnet mode, a subnetwork must be specified.",
"type": "string"
},
"target": {
"description": "The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must live in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. For INTERNAL_SELF_MANAGED load balancing, only targetHttpProxy is valid, not targetHttpsProxy.",
"type": "string"
}
},
"type": "object"
},
"ForwardingRuleAggregatedList": {
"id": "ForwardingRuleAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "ForwardingRulesScopedList",
"description": "Name of the scope containing this set of addresses."
},
"description": "A list of ForwardingRulesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#forwardingRuleAggregatedList",
"description": "[Output Only] Type of resource. Always compute#forwardingRuleAggregatedList for lists of forwarding rules.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ForwardingRuleList": {
"description": "Contains a list of ForwardingRule resources.",
"id": "ForwardingRuleList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of ForwardingRule resources.",
"items": {
"$ref": "ForwardingRule"
},
"type": "array"
},
"kind": {
"default": "compute#forwardingRuleList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ForwardingRuleReference": {
"id": "ForwardingRuleReference",
"properties": {
"forwardingRule": {
"type": "string"
}
},
"type": "object"
},
"ForwardingRulesScopedList": {
"id": "ForwardingRulesScopedList",
"properties": {
"forwardingRules": {
"description": "A list of forwarding rules contained in this scope.",
"items": {
"$ref": "ForwardingRule"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of forwarding rules when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"GlobalNetworkEndpointGroupsAttachEndpointsRequest": {
"id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be attached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"GlobalNetworkEndpointGroupsDetachEndpointsRequest": {
"id": "GlobalNetworkEndpointGroupsDetachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be detached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"GlobalSetLabelsRequest": {
"id": "GlobalSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "A list of labels to apply for this resource. Each label key \u0026 value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, \"webserver-frontend\": \"images\". A label value can also be empty (e.g. \"my-label\": \"\").",
"type": "object"
}
},
"type": "object"
},
"GlobalSetPolicyRequest": {
"id": "GlobalSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte",
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"GuestAttributes": {
"description": "A guest attributes entry.",
"id": "GuestAttributes",
"properties": {
"kind": {
"default": "compute#guestAttributes",
"description": "[Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry.",
"type": "string"
},
"queryPath": {
"description": "The path to be queried. This can be the default namespace ('/') or a nested namespace ('/\\/') or a specified key ('/\\/\\')",
"type": "string"
},
"queryValue": {
"$ref": "GuestAttributesValue",
"description": "[Output Only] The value of the requested queried path."
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"variableKey": {
"description": "The key to search for.",
"type": "string"
},
"variableValue": {
"description": "[Output Only] The value found for the requested key.",
"type": "string"
}
},
"type": "object"
},
"GuestAttributesEntry": {
"description": "A guest attributes namespace/key/value entry.",
"id": "GuestAttributesEntry",
"properties": {
"key": {
"description": "Key for the guest attribute entry.",
"type": "string"
},
"namespace": {
"description": "Namespace for the guest attribute entry.",
"type": "string"
},
"value": {
"description": "Value for the guest attribute entry.",
"type": "string"
}
},
"type": "object"
},
"GuestAttributesValue": {
"description": "Array of guest attribute namespace/key/value tuples.",
"id": "GuestAttributesValue",
"properties": {
"items": {
"items": {
"$ref": "GuestAttributesEntry"
},
"type": "array"
}
},
"type": "object"
},
"GuestOsFeature": {
"description": "Guest OS features.",
"id": "GuestOsFeature",
"properties": {
"type": {
"description": "The ID of a supported feature. Read Enabling guest operating system features to see a list of available options.",
"enum": [
"FEATURE_TYPE_UNSPECIFIED",
"MULTI_IP_SUBNET",
"SECURE_BOOT",
"UEFI_COMPATIBLE",
"VIRTIO_SCSI_MULTIQUEUE",
"WINDOWS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"HTTP2HealthCheck": {
"id": "HTTP2HealthCheck",
"properties": {
"host": {
"description": "The value of the host header in the HTTP/2 health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
"type": "string"
},
"port": {
"description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in port is used for health checking.\nUSE_NAMED_PORT: The portName is used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP2 health check follows behavior specified in port and portName fields.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTP/2 health check request. The default value is /.",
"type": "string"
},
"response": {
"description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
"type": "string"
}
},
"type": "object"
},
"HTTPHealthCheck": {
"id": "HTTPHealthCheck",
"properties": {
"host": {
"description": "The value of the host header in the HTTP health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
"type": "string"
},
"port": {
"description": "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in port is used for health checking.\nUSE_NAMED_PORT: The portName is used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTP health check follows behavior specified in port and portName fields.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTP health check request. The default value is /.",
"type": "string"
},
"response": {
"description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
"type": "string"
}
},
"type": "object"
},
"HTTPSHealthCheck": {
"id": "HTTPSHealthCheck",
"properties": {
"host": {
"description": "The value of the host header in the HTTPS health check request. If left empty (default value), the IP on behalf of which this health check is performed will be used.",
"type": "string"
},
"port": {
"description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in port is used for health checking.\nUSE_NAMED_PORT: The portName is used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, HTTPS health check follows behavior specified in port and portName fields.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTPS health check request. The default value is /.",
"type": "string"
},
"response": {
"description": "The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII.",
"type": "string"
}
},
"type": "object"
},
"HealthCheck": {
"description": "Represents a Health Check resource.\n\nGoogle Compute Engine has two Health Check resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/healthChecks) * [Regional](/compute/docs/reference/rest/{$api_version}/regionHealthChecks)\n\nInternal HTTP(S) load balancers use regional health checks. All other types of GCP load balancers and managed instance group auto-healing use global health checks. For more information, read Health Check Concepts.\n\nTo perform health checks on network load balancers, you must use either httpHealthChecks or httpsHealthChecks.",
"id": "HealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in 3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
"format": "int32",
"type": "integer"
},
"http2HealthCheck": {
"$ref": "HTTP2HealthCheck"
},
"httpHealthCheck": {
"$ref": "HTTPHealthCheck"
},
"httpsHealthCheck": {
"$ref": "HTTPSHealthCheck"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#healthCheck",
"description": "Type of the resource.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "[Output Only] Region where the health check resides. Not applicable to global health checks.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sslHealthCheck": {
"$ref": "SSLHealthCheck"
},
"tcpHealthCheck": {
"$ref": "TCPHealthCheck"
},
"timeoutSec": {
"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS or HTTP2. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.",
"enum": [
"HTTP",
"HTTP2",
"HTTPS",
"INVALID",
"SSL",
"TCP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"HealthCheckList": {
"description": "Contains a list of HealthCheck resources.",
"id": "HealthCheckList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of HealthCheck resources.",
"items": {
"$ref": "HealthCheck"
},
"type": "array"
},
"kind": {
"default": "compute#healthCheckList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"HealthCheckReference": {
"description": "A full or valid partial URL to a health check. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check \n- projects/project-id/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check",
"id": "HealthCheckReference",
"properties": {
"healthCheck": {
"type": "string"
}
},
"type": "object"
},
"HealthChecksAggregatedList": {
"id": "HealthChecksAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "HealthChecksScopedList",
"description": "Name of the scope containing this set of HealthChecks."
},
"description": "A list of HealthChecksScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#healthChecksAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"HealthChecksScopedList": {
"id": "HealthChecksScopedList",
"properties": {
"healthChecks": {
"description": "A list of HealthChecks contained in this scope.",
"items": {
"$ref": "HealthCheck"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"HealthStatus": {
"id": "HealthStatus",
"properties": {
"healthState": {
"description": "Health state of the instance.",
"enum": [
"HEALTHY",
"UNHEALTHY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"instance": {
"description": "URL of the instance resource.",
"type": "string"
},
"ipAddress": {
"description": "A forwarding rule IP address assigned to this instance.",
"type": "string"
},
"port": {
"description": "The named port of the instance group, not necessarily the port that is health-checked.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"HealthStatusForNetworkEndpoint": {
"id": "HealthStatusForNetworkEndpoint",
"properties": {
"backendService": {
"$ref": "BackendServiceReference",
"description": "URL of the backend service associated with the health state of the network endpoint."
},
"forwardingRule": {
"$ref": "ForwardingRuleReference",
"description": "URL of the forwarding rule associated with the health state of the network endpoint."
},
"healthCheck": {
"$ref": "HealthCheckReference",
"description": "URL of the health check associated with the health state of the network endpoint."
},
"healthState": {
"description": "Health state of the network endpoint determined based on the health checks configured.",
"enum": [
"DRAINING",
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"HostRule": {
"description": "UrlMaps A host-matching rule for a URL. If matched, will use the named PathMatcher to select the BackendService.",
"id": "HostRule",
"properties": {
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"hosts": {
"description": "The list of host patterns to match. They must be valid hostnames with optional port numbers in the format host:port. * matches any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..",
"items": {
"type": "string"
},
"type": "array"
},
"pathMatcher": {
"description": "The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL's host portion.",
"type": "string"
}
},
"type": "object"
},
"HttpFaultAbort": {
"description": "Specification for how requests are aborted as part of fault injection.",
"id": "HttpFaultAbort",
"properties": {
"httpStatus": {
"description": "The HTTP status code used to abort the request.\nThe value must be between 200 and 599 inclusive.",
"format": "uint32",
"type": "integer"
},
"percentage": {
"description": "The percentage of traffic (connections/operations/requests) which will be aborted as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"HttpFaultDelay": {
"description": "Specifies the delay introduced by Loadbalancer before forwarding the request to the backend service as part of fault injection.",
"id": "HttpFaultDelay",
"properties": {
"fixedDelay": {
"$ref": "Duration",
"description": "Specifies the value of the fixed delay interval."
},
"percentage": {
"description": "The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection.\nThe value must be between 0.0 and 100.0 inclusive.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"HttpFaultInjection": {
"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.",
"id": "HttpFaultInjection",
"properties": {
"abort": {
"$ref": "HttpFaultAbort",
"description": "The specification for how client requests are aborted as part of fault injection."
},
"delay": {
"$ref": "HttpFaultDelay",
"description": "The specification for how client requests are delayed as part of fault injection, before being sent to a backend service."
}
},
"type": "object"
},
"HttpHeaderAction": {
"description": "The request and response header transformations that take effect before the request is passed along to the selected backendService.",
"id": "HttpHeaderAction",
"properties": {
"requestHeadersToAdd": {
"description": "Headers to add to a matching request prior to forwarding the request to the backendService.",
"items": {
"$ref": "HttpHeaderOption"
},
"type": "array"
},
"requestHeadersToRemove": {
"description": "A list of header names for headers that need to be removed from the request prior to forwarding the request to the backendService.",
"items": {
"type": "string"
},
"type": "array"
},
"responseHeadersToAdd": {
"description": "Headers to add the response prior to sending the response back to the client.",
"items": {
"$ref": "HttpHeaderOption"
},
"type": "array"
},
"responseHeadersToRemove": {
"description": "A list of header names for headers that need to be removed from the response prior to sending the response back to the client.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"HttpHeaderMatch": {
"description": "matchRule criteria for request header matches.",
"id": "HttpHeaderMatch",
"properties": {
"exactMatch": {
"description": "The value should exactly match contents of exactMatch.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
"type": "string"
},
"headerName": {
"description": "The name of the HTTP header to match.\nFor matching against the HTTP request's authority, use a headerMatch with the header name \":authority\".\nFor matching a request's method, use the headerName \":method\".",
"type": "string"
},
"invertMatch": {
"description": "If set to false, the headerMatch is considered a match if the match criteria above are met. If set to true, the headerMatch is considered a match if the match criteria above are NOT met.\nThe default setting is false.",
"type": "boolean"
},
"prefixMatch": {
"description": "The value of the header must start with the contents of prefixMatch.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
"type": "string"
},
"presentMatch": {
"description": "A header with the contents of headerName must exist. The match takes place whether or not the request's header has a value.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
"type": "boolean"
},
"rangeMatch": {
"$ref": "Int64RangeMatch",
"description": "The header value must be an integer and its value must be in the range specified in rangeMatch. If the header does not contain an integer, number or is empty, the match fails.\nFor example for a range [-5, 0] \n- -3 will match. \n- 0 will not match. \n- 0.25 will not match. \n- -3someString will not match. \nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.\nNote that rangeMatch is not supported for Loadbalancers that have their loadBalancingScheme set to EXTERNAL."
},
"regexMatch": {
"description": "The value of the header must match the regular expression specified in regexMatch. For regular expression grammar, please see: en.cppreference.com/w/cpp/regex/ecmascript \nFor matching against a port specified in the HTTP request, use a headerMatch with headerName set to PORT and a regular expression that satisfies the RFC2616 Host header's port specifier.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
"type": "string"
},
"suffixMatch": {
"description": "The value of the header must end with the contents of suffixMatch.\nOnly one of exactMatch, prefixMatch, suffixMatch, regexMatch, presentMatch or rangeMatch must be set.",
"type": "string"
}
},
"type": "object"
},
"HttpHeaderOption": {
"description": "Specification determining how headers are added to requests or responses.",
"id": "HttpHeaderOption",
"properties": {
"headerName": {
"description": "The name of the header.",
"type": "string"
},
"headerValue": {
"description": "The value of the header to add.",
"type": "string"
},
"replace": {
"description": "If false, headerValue is appended to any values that already exist for the header. If true, headerValue is set for the header, discarding any values that were set for that header.\nThe default value is false.",
"type": "boolean"
}
},
"type": "object"
},
"HttpHealthCheck": {
"description": "Represents a legacy HTTP Health Check resource.\n\nLegacy health checks are required by network load balancers. For more information, read Health Check Concepts.",
"id": "HttpHealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
"format": "int32",
"type": "integer"
},
"host": {
"description": "The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#httpHealthCheck",
"description": "[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"port": {
"description": "The TCP port number for the HTTP health check request. The default value is 80.",
"format": "int32",
"type": "integer"
},
"requestPath": {
"description": "The request path of the HTTP health check request. The default value is /. This field does not support query parameters.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"timeoutSec": {
"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.",
"format": "int32",
"type": "integer"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"HttpHealthCheckList": {
"description": "Contains a list of HttpHealthCheck resources.",
"id": "HttpHealthCheckList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of HttpHealthCheck resources.",
"items": {
"$ref": "HttpHealthCheck"
},
"type": "array"
},
"kind": {
"default": "compute#httpHealthCheckList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"HttpQueryParameterMatch": {
"description": "HttpRouteRuleMatch criteria for a request's query parameter.",
"id": "HttpQueryParameterMatch",
"properties": {
"exactMatch": {
"description": "The queryParameterMatch matches if the value of the parameter exactly matches the contents of exactMatch.\nOnly one of presentMatch, exactMatch or regexMatch must be set.",
"type": "string"
},
"name": {
"description": "The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.",
"type": "string"
},
"presentMatch": {
"description": "Specifies that the queryParameterMatch matches if the request contains the query parameter, irrespective of whether the parameter has a value or not.\nOnly one of presentMatch, exactMatch or regexMatch must be set.",
"type": "boolean"
},
"regexMatch": {
"description": "The queryParameterMatch matches if the value of the parameter matches the regular expression specified by regexMatch. For the regular expression grammar, please see en.cppreference.com/w/cpp/regex/ecmascript \nOnly one of presentMatch, exactMatch or regexMatch must be set.\nNote that regexMatch only applies when the loadBalancingScheme is set to INTERNAL_SELF_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"HttpRedirectAction": {
"description": "Specifies settings for an HTTP redirect.",
"id": "HttpRedirectAction",
"properties": {
"hostRedirect": {
"description": "The host that will be used in the redirect response instead of the one that was supplied in the request.\nThe value must be between 1 and 255 characters.",
"type": "string"
},
"httpsRedirect": {
"description": "If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request.\nThis must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted.\nThe default is set to false.",
"type": "boolean"
},
"pathRedirect": {
"description": "The path that will be used in the redirect response instead of the one that was supplied in the request.\npathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.\nThe value must be between 1 and 1024 characters.",
"type": "string"
},
"prefixRedirect": {
"description": "The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request.\nprefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect.\nThe value must be between 1 and 1024 characters.",
"type": "string"
},
"redirectResponseCode": {
"description": "The HTTP Status code to use for this RedirectAction.\nSupported values are: \n- MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. \n- FOUND, which corresponds to 302. \n- SEE_OTHER which corresponds to 303. \n- TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. \n- PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.",
"enum": [
"FOUND",
"MOVED_PERMANENTLY_DEFAULT",
"PERMANENT_REDIRECT",
"SEE_OTHER",
"TEMPORARY_REDIRECT"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"stripQuery": {
"description": "If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained.\nThe default is set to false.",
"type": "boolean"
}
},
"type": "object"
},
"HttpRetryPolicy": {
"description": "The retry policy associates with HttpRouteRule",
"id": "HttpRetryPolicy",
"properties": {
"numRetries": {
"description": "Specifies the allowed number retries. This number must be \u003e 0. If not specified, defaults to 1.",
"format": "uint32",
"type": "integer"
},
"perTryTimeout": {
"$ref": "Duration",
"description": "Specifies a non-zero timeout per retry attempt.\nIf not specified, will use the timeout set in HttpRouteAction. If timeout in HttpRouteAction is not set, will use the largest timeout among all backend services associated with the route."
},
"retryConditions": {
"description": "Specfies one or more conditions when this retry rule applies. Valid values are: \n- 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. \n- gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504.\n- \n- connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. \n- retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. \n- refused-stream:Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. \n- cancelledLoadbalancer will retry if the gRPC status code in the response header is set to cancelled \n- deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded \n- resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted \n- unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"HttpRouteAction": {
"id": "HttpRouteAction",
"properties": {
"corsPolicy": {
"$ref": "CorsPolicy",
"description": "The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing"
},
"faultInjectionPolicy": {
"$ref": "HttpFaultInjection",
"description": "The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests.\ntimeout and retry_policy will be ignored by clients that are configured with a fault_injection_policy."
},
"requestMirrorPolicy": {
"$ref": "RequestMirrorPolicy",
"description": "Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow."
},
"retryPolicy": {
"$ref": "HttpRetryPolicy",
"description": "Specifies the retry policy associated with this route."
},
"timeout": {
"$ref": "Duration",
"description": "Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries.\nIf not specified, will use the largest timeout among all backend services associated with the route."
},
"urlRewrite": {
"$ref": "UrlRewrite",
"description": "The spec to modify the URL of the request, prior to forwarding the request to the matched service."
},
"weightedBackendServices": {
"description": "A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number.\nOnce a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.",
"items": {
"$ref": "WeightedBackendService"
},
"type": "array"
}
},
"type": "object"
},
"HttpRouteRule": {
"description": "An HttpRouteRule specifies how to match an HTTP request and the corresponding routing action that load balancing proxies will perform.",
"id": "HttpRouteRule",
"properties": {
"description": {
"description": "The short description conveying the intent of this routeRule.\nThe description can have a maximum length of 1024 characters.",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect for the selected backendService.\nThe headerAction specified here are applied before the matching pathMatchers[].headerAction and after pathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction"
},
"matchRules": {
"items": {
"$ref": "HttpRouteRuleMatch"
},
"type": "array"
},
"priority": {
"description": "For routeRules within a given pathMatcher, priority determines the order in which load balancer will interpret routeRules. RouteRules are evaluated in order of priority, from the lowest to highest number. The priority of a rule decreases as its number increases (1, 2, 3, N+1). The first rule that matches the request is applied.\nYou cannot configure two or more routeRules with the same priority. Priority for each rule must be set to a number between 0 and 2147483647 inclusive.\nPriority numbers can have gaps, which enable you to add or remove rules in the future without affecting the rest of the rules. For example, 1, 2, 3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you could add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future without any impact on existing rules.",
"format": "int32",
"type": "integer"
},
"routeAction": {
"$ref": "HttpRouteAction",
"description": "In response to a matching matchRule, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set."
},
"service": {
"description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set.",
"type": "string"
},
"urlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When this rule is matched, the request is redirected to a URL specified by urlRedirect.\nIf urlRedirect is specified, service or routeAction must not be set."
}
},
"type": "object"
},
"HttpRouteRuleMatch": {
"description": "HttpRouteRuleMatch specifies a set of criteria for matching requests to an HttpRouteRule. All specified criteria must be satisfied for a match to occur.",
"id": "HttpRouteRuleMatch",
"properties": {
"fullPathMatch": {
"description": "For satisfying the matchRule condition, the path of the request must exactly match the value specified in fullPathMatch after removing any query parameters and anchor that may be part of the original URL.\nfullPathMatch must be between 1 and 1024 characters.\nOnly one of prefixMatch, fullPathMatch or regexMatch must be specified.",
"type": "string"
},
"headerMatches": {
"description": "Specifies a list of header match criteria, all of which must match corresponding headers in the request.",
"items": {
"$ref": "HttpHeaderMatch"
},
"type": "array"
},
"ignoreCase": {
"description": "Specifies that prefixMatch and fullPathMatch matches are case sensitive.\nThe default value is false.\nignoreCase must not be used with regexMatch.",
"type": "boolean"
},
"metadataFilters": {
"description": "Opaque filter criteria used by Loadbalancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to Loadbalancer, xDS clients present node metadata. If a match takes place, the relevant routing configuration is made available to those proxies.\nFor each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.\nmetadataFilters specified here will be applied after those specified in ForwardingRule that refers to the UrlMap this HttpRouteRuleMatch belongs to.\nmetadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
"items": {
"$ref": "MetadataFilter"
},
"type": "array"
},
"prefixMatch": {
"description": "For satisfying the matchRule condition, the request's path must begin with the specified prefixMatch. prefixMatch must begin with a /.\nThe value must be between 1 and 1024 characters.\nOnly one of prefixMatch, fullPathMatch or regexMatch must be specified.",
"type": "string"
},
"queryParameterMatches": {
"description": "Specifies a list of query parameter match criteria, all of which must match corresponding query parameters in the request.",
"items": {
"$ref": "HttpQueryParameterMatch"
},
"type": "array"
},
"regexMatch": {
"description": "For satisfying the matchRule condition, the path of the request must satisfy the regular expression specified in regexMatch after removing any query parameters and anchor supplied with the original URL. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript \nOnly one of prefixMatch, fullPathMatch or regexMatch must be specified.\nNote that regexMatch only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"HttpsHealthCheck": {
"description": "Represents a legacy HTTPS Health Check resource.\n\nLegacy health checks are required by network load balancers. For more information, read Health Check Concepts.",
"id": "HttpsHealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is 5 seconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.",
"format": "int32",
"type": "integer"
},
"host": {
"description": "The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#httpsHealthCheck",
"description": "Type of the resource.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"port": {
"description": "The TCP port number for the HTTPS health check request. The default value is 443.",
"format": "int32",
"type": "integer"
},
"requestPath": {
"description": "The request path of the HTTPS health check request. The default value is \"/\".",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"timeoutSec": {
"description": "How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec.",
"format": "int32",
"type": "integer"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"HttpsHealthCheckList": {
"description": "Contains a list of HttpsHealthCheck resources.",
"id": "HttpsHealthCheckList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of HttpsHealthCheck resources.",
"items": {
"$ref": "HttpsHealthCheck"
},
"type": "array"
},
"kind": {
"default": "compute#httpsHealthCheckList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Image": {
"description": "Represents an Image resource.\n\nYou can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.images ==)",
"id": "Image",
"properties": {
"archiveSizeBytes": {
"description": "Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).",
"format": "int64",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "The deprecation status associated with this image."
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"diskSizeGb": {
"description": "Size of the image when restored onto a persistent disk (in GB).",
"format": "int64",
"type": "string"
},
"family": {
"description": "The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.",
"type": "string"
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"imageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the image using a customer-supplied encryption key.\n\nAfter you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image).\n\nCustomer-supplied encryption keys do not protect access to metadata of the disk.\n\nIf you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later."
},
"kind": {
"default": "compute#image",
"description": "[Output Only] Type of the resource. Always compute#image for images.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an image.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this image. These can be later modified by the setLabels method.",
"type": "object"
},
"licenseCodes": {
"description": "Integer license codes indicating which licenses are attached to this image.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"licenses": {
"description": "Any applicable license URI.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.images.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"rawDisk": {
"description": "The parameters of the raw disk image.",
"properties": {
"containerType": {
"description": "The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.",
"enum": [
"TAR"
],
"enumDescriptions": [
""
],
"type": "string"
},
"sha1Checksum": {
"description": "[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created.",
"pattern": "[a-f0-9]{40}",
"type": "string"
},
"source": {
"annotations": {
"required": [
"compute.images.insert"
]
},
"description": "The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both.",
"type": "string"
}
},
"type": "object"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"shieldedInstanceInitialState": {
"$ref": "InitialStateConfig",
"description": "Set the secure boot keys of shielded instance."
},
"sourceDisk": {
"description": "URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk \n- projects/project/zones/zone/disks/disk \n- zones/zone/disks/disk",
"type": "string"
},
"sourceDiskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key."
},
"sourceDiskId": {
"description": "[Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name.",
"type": "string"
},
"sourceImage": {
"description": "URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: \n- this property, or \n- the rawDisk.source property, or \n- the sourceDisk property in order to create an image.",
"type": "string"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key."
},
"sourceImageId": {
"description": "[Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name.",
"type": "string"
},
"sourceSnapshot": {
"description": "URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: \n- this property, or \n- the sourceImage property, or \n- the rawDisk.source property, or \n- the sourceDisk property in order to create an image.",
"type": "string"
},
"sourceSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key."
},
"sourceSnapshotId": {
"description": "[Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.",
"type": "string"
},
"sourceType": {
"default": "RAW",
"description": "The type of the image used to create this disk. The default and only value is RAW",
"enum": [
"RAW"
],
"enumDescriptions": [
""
],
"type": "string"
},
"status": {
"description": "[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.",
"enum": [
"DELETING",
"FAILED",
"PENDING",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the image (regional or multi-regional).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageList": {
"description": "Contains a list of images.",
"id": "ImageList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Image resources.",
"items": {
"$ref": "Image"
},
"type": "array"
},
"kind": {
"default": "compute#imageList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InitialStateConfig": {
"description": "Initial State for shielded instance, these are public keys which are safe to store in public",
"id": "InitialStateConfig",
"properties": {
"dbs": {
"description": "The Key Database (db).",
"items": {
"$ref": "FileContentBuffer"
},
"type": "array"
},
"dbxs": {
"description": "The forbidden key database (dbx).",
"items": {
"$ref": "FileContentBuffer"
},
"type": "array"
},
"keks": {
"description": "The Key Exchange Key (KEK).",
"items": {
"$ref": "FileContentBuffer"
},
"type": "array"
},
"pk": {
"$ref": "FileContentBuffer",
"description": "The Platform Key (PK)."
}
},
"type": "object"
},
"Instance": {
"description": "Represents an Instance resource.\n\nAn instance is a virtual machine that is hosted on Google Cloud Platform. For more information, read Virtual Machine Instances. (== resource_for {$api_version}.instances ==)",
"id": "Instance",
"properties": {
"canIpForward": {
"description": "Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding.",
"type": "boolean"
},
"cpuPlatform": {
"description": "[Output Only] The CPU platform used by this instance.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deletionProtection": {
"description": "Whether the resource should be protected against deletion.",
"type": "boolean"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"disks": {
"description": "Array of disks associated with this instance. Persistent disks must be created before you can assign them.",
"items": {
"$ref": "AttachedDisk"
},
"type": "array"
},
"displayDevice": {
"$ref": "DisplayDevice",
"description": "Enables display device for the instance."
},
"fingerprint": {
"description": "Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance.\n\nTo see the latest fingerprint, make get() request to the instance.",
"format": "byte",
"type": "string"
},
"guestAccelerators": {
"description": "A list of the type and count of accelerator cards attached to the instance.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"hostname": {
"description": "Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#instance",
"description": "[Output Only] Type of the resource. Always compute#instance for instances.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the instance.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this instance. These can be later modified by the setLabels method.",
"type": "object"
},
"machineType": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type:\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB):\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120 \n\nFor a full list of restrictions, read the Specifications for custom machine types.",
"type": "string"
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys."
},
"minCpuPlatform": {
"description": "Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\".",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"networkInterfaces": {
"description": "An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.",
"items": {
"$ref": "NetworkInterface"
},
"type": "array"
},
"privateIpv6GoogleAccess": {
"description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.",
"enum": [
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
"INHERIT_FROM_SUBNETWORK"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"reservationAffinity": {
"$ref": "ReservationAffinity",
"description": "Specifies the reservations that this instance can consume from."
},
"resourcePolicies": {
"description": "Resource policies applied to this instance.",
"items": {
"type": "string"
},
"type": "array"
},
"scheduling": {
"$ref": "Scheduling",
"description": "Sets the scheduling options for this instance."
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"serviceAccounts": {
"description": "A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported.\n\nService accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig"
},
"shieldedInstanceIntegrityPolicy": {
"$ref": "ShieldedInstanceIntegrityPolicy"
},
"startRestricted": {
"description": "[Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.",
"type": "boolean"
},
"status": {
"description": "[Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, and TERMINATED.",
"enum": [
"DEPROVISIONING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"statusMessage": {
"description": "[Output Only] An optional, human-readable explanation of the status.",
"type": "string"
},
"tags": {
"$ref": "Tags",
"description": "Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field."
},
"zone": {
"description": "[Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"InstanceAggregatedList": {
"id": "InstanceAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InstancesScopedList",
"description": "[Output Only] Name of the scope containing this set of instances."
},
"description": "An object that contains a list of instances scoped by zone.",
"type": "object"
},
"kind": {
"default": "compute#instanceAggregatedList",
"description": "[Output Only] Type of resource. Always compute#instanceAggregatedList for aggregated lists of Instance resources.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroup": {
"description": "Represents an Instance Group resource.\n\nInstance Groups can be used to configure a target for load balancing.\n\nInstance groups can either be managed or unmanaged.\n\nTo create managed instance groups, use the instanceGroupManager or regionInstanceGroupManager resource instead.\n\nUse zonal unmanaged instance groups if you need to apply load balancing to groups of heterogeneous instances or if you need to manage the instances yourself. You cannot create regional unmanaged instance groups.\n\nFor more information, read Instance groups.\n\n(== resource_for {$api_version}.instanceGroups ==) (== resource_for {$api_version}.regionInstanceGroups ==)",
"id": "InstanceGroup",
"properties": {
"creationTimestamp": {
"description": "[Output Only] The creation timestamp for this instance group in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"fingerprint": {
"description": "[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] A unique identifier for this instance group, generated by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#instanceGroup",
"description": "[Output Only] The resource type, which is always compute#instanceGroup for instance groups.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceGroups.insert"
]
},
"description": "The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"namedPorts": {
"description": "Assigns a name to a port number. For example: {name: \"http\", port: 80}\n\nThis allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: \"http\", port: 80},{name: \"http\", port: 8080}] \n\nNamed ports apply to all instances in this instance group.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
},
"network": {
"description": "[Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).",
"type": "string"
},
"region": {
"description": "[Output Only] The URL of the region where the instance group is located (for regional resources).",
"type": "string"
},
"selfLink": {
"description": "[Output Only] The URL for this instance group. The server generates this URL.",
"type": "string"
},
"size": {
"description": "[Output Only] The total number of instances in the instance group.",
"format": "int32",
"type": "integer"
},
"subnetwork": {
"description": "[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0).",
"type": "string"
},
"zone": {
"description": "[Output Only] The URL of the zone where the instance group is located (for zonal resources).",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupAggregatedList": {
"id": "InstanceGroupAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InstanceGroupsScopedList",
"description": "The name of the scope that contains this set of instance groups."
},
"description": "A list of InstanceGroupsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#instanceGroupAggregatedList",
"description": "[Output Only] The resource type, which is always compute#instanceGroupAggregatedList for aggregated lists of instance groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupList": {
"description": "A list of InstanceGroup resources.",
"id": "InstanceGroupList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceGroup resources.",
"items": {
"$ref": "InstanceGroup"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupList",
"description": "[Output Only] The resource type, which is always compute#instanceGroupList for instance group lists.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManager": {
"description": "Represents a Managed Instance Group resource.\n\nAn instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups.\n\nFor zonal Managed Instance Group, use the instanceGroupManagers resource.\n\nFor regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)",
"id": "InstanceGroupManager",
"properties": {
"autoHealingPolicies": {
"description": "The autohealing policy for this managed instance group. You can specify only one value.",
"items": {
"$ref": "InstanceGroupManagerAutoHealingPolicy"
},
"type": "array"
},
"baseInstanceName": {
"annotations": {
"required": [
"compute.instanceGroupManagers.insert"
]
},
"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.",
"pattern": "[a-z][-a-z0-9]{0,57}",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.",
"type": "string"
},
"currentActions": {
"$ref": "InstanceGroupManagerActionsSummary",
"description": "[Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions."
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"distributionPolicy": {
"$ref": "DistributionPolicy",
"description": "Policy specifying intended distribution of instances in regional managed instance group."
},
"fingerprint": {
"description": "Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] A unique identifier for this resource type. The server generates this identifier.",
"format": "uint64",
"type": "string"
},
"instanceGroup": {
"description": "[Output Only] The URL of the Instance Group resource.",
"type": "string"
},
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.",
"type": "string"
},
"kind": {
"default": "compute#instanceGroupManager",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceGroupManagers.insert",
"compute.regionInstanceGroupManagers.insert"
]
},
"description": "The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"namedPorts": {
"description": "Named ports configured for the Instance Groups complementary to this Instance Group Manager.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
},
"region": {
"description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).",
"type": "string"
},
"selfLink": {
"description": "[Output Only] The URL for this managed instance group. The server defines this URL.",
"type": "string"
},
"status": {
"$ref": "InstanceGroupManagerStatus",
"description": "[Output Only] The status of this managed instance group."
},
"targetPools": {
"description": "The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
"items": {
"type": "string"
},
"type": "array"
},
"targetSize": {
"annotations": {
"required": [
"compute.instanceGroupManagers.insert",
"compute.regionInstanceGroupManagers.insert"
]
},
"description": "The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.",
"format": "int32",
"type": "integer"
},
"updatePolicy": {
"$ref": "InstanceGroupManagerUpdatePolicy",
"description": "The update policy for this managed instance group."
},
"versions": {
"description": "Specifies the instance templates used by this managed instance group to create instances.\n\nEach version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.",
"items": {
"$ref": "InstanceGroupManagerVersion"
},
"type": "array"
},
"zone": {
"description": "[Output Only] The URL of the zone where the managed instance group is located (for zonal resources).",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerActionsSummary": {
"id": "InstanceGroupManagerActionsSummary",
"properties": {
"abandoning": {
"description": "[Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it.",
"format": "int32",
"type": "integer"
},
"creating": {
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be created or are currently being created. If the group fails to create any of these instances, it tries again until it creates the instance successfully.\n\nIf you have disabled creation retries, this field will not be populated; instead, the creatingWithoutRetries field will be populated.",
"format": "int32",
"type": "integer"
},
"creatingWithoutRetries": {
"description": "[Output Only] The number of instances that the managed instance group will attempt to create. The group attempts to create each instance only once. If the group fails to create any of these instances, it decreases the group's targetSize value accordingly.",
"format": "int32",
"type": "integer"
},
"deleting": {
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be deleted or are currently being deleted.",
"format": "int32",
"type": "integer"
},
"none": {
"description": "[Output Only] The number of instances in the managed instance group that are running and have no scheduled actions.",
"format": "int32",
"type": "integer"
},
"recreating": {
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be recreated or are currently being being recreated. Recreating an instance deletes the existing root persistent disk and creates a new disk from the image that is defined in the instance template.",
"format": "int32",
"type": "integer"
},
"refreshing": {
"description": "[Output Only] The number of instances in the managed instance group that are being reconfigured with properties that do not require a restart or a recreate action. For example, setting or removing target pools for the instance.",
"format": "int32",
"type": "integer"
},
"restarting": {
"description": "[Output Only] The number of instances in the managed instance group that are scheduled to be restarted or are currently being restarted.",
"format": "int32",
"type": "integer"
},
"verifying": {
"description": "[Output Only] The number of instances in the managed instance group that are being verified. See the managedInstances[].currentAction property in the listManagedInstances method documentation.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerAggregatedList": {
"id": "InstanceGroupManagerAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InstanceGroupManagersScopedList",
"description": "[Output Only] The name of the scope that contains this set of managed instance groups."
},
"description": "A list of InstanceGroupManagersScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#instanceGroupManagerAggregatedList",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManagerAggregatedList for an aggregated list of managed instance groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerAutoHealingPolicy": {
"description": "",
"id": "InstanceGroupManagerAutoHealingPolicy",
"properties": {
"healthCheck": {
"description": "The URL for the health check that signals autohealing.",
"type": "string"
},
"initialDelaySec": {
"description": "The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. This initial delay allows instances to initialize and run their startup scripts before the instance group determines that they are UNHEALTHY. This prevents the managed instance group from recreating its instances prematurely. This value must be from range [0, 3600].",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerList": {
"description": "[Output Only] A list of managed instance groups.",
"id": "InstanceGroupManagerList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceGroupManager resources.",
"items": {
"$ref": "InstanceGroupManager"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupManagerList",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerStatus": {
"id": "InstanceGroupManagerStatus",
"properties": {
"autoscaler": {
"description": "[Output Only] The URL of the Autoscaler that targets this instance group manager.",
"type": "string"
},
"isStable": {
"description": "[Output Only] A bit indicating whether the managed instance group is in a stable state. A stable state means that: none of the instances in the managed instance group is currently undergoing any type of change (for example, creation, restart, or deletion); no future changes are scheduled for instances in the managed instance group; and the managed instance group itself is not being modified.",
"type": "boolean"
},
"versionTarget": {
"$ref": "InstanceGroupManagerStatusVersionTarget",
"description": "[Output Only] A status of consistency of Instances' versions with their target version specified by version field on Instance Group Manager."
}
},
"type": "object"
},
"InstanceGroupManagerStatusVersionTarget": {
"id": "InstanceGroupManagerStatusVersionTarget",
"properties": {
"isReached": {
"description": "[Output Only] A bit indicating whether version target has been reached in this managed instance group, i.e. all instances are in their target version. Instances' target version are specified by version field on Instance Group Manager.",
"type": "boolean"
}
},
"type": "object"
},
"InstanceGroupManagerUpdatePolicy": {
"id": "InstanceGroupManagerUpdatePolicy",
"properties": {
"instanceRedistributionType": {
"description": "The instance redistribution policy for regional managed instance groups. Valid values are: \n- PROACTIVE (default): The group attempts to maintain an even distribution of VM instances across zones in the region. \n- NONE: For non-autoscaled groups, proactive redistribution is disabled.",
"enum": [
"NONE",
"PROACTIVE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"maxSurge": {
"$ref": "FixedOrPercent",
"description": "The maximum number of instances that can be created above the specified targetSize during the update process. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxSurge."
},
"maxUnavailable": {
"$ref": "FixedOrPercent",
"description": "The maximum number of instances that can be unavailable during the update process. An instance is considered available if all of the following conditions are satisfied:\n\n \n- The instance's status is RUNNING. \n- If there is a health check on the instance group, the instance's liveness health check result must be HEALTHY at least once. If there is no health check on the group, then the instance only needs to have a status of RUNNING to be considered available. By default, a fixed value of 1 is used. This value can be either a fixed number or a percentage if the instance group has 10 or more instances. If you set a percentage, the number of instances will be rounded up if necessary.\n\nAt least one of either maxSurge or maxUnavailable must be greater than 0. Learn more about maxUnavailable."
},
"minimalAction": {
"description": "Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"replacementMethod": {
"description": "What action should be used to replace instances. See minimal_action.REPLACE",
"enum": [
"RECREATE",
"SUBSTITUTE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"type": {
"description": "The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).",
"enum": [
"OPPORTUNISTIC",
"PROACTIVE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerVersion": {
"id": "InstanceGroupManagerVersion",
"properties": {
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create new instances in the managed instance group until the `targetSize` for this version is reached.",
"type": "string"
},
"name": {
"description": "Name of the version. Unique among all versions in the scope of this managed instance group.",
"type": "string"
},
"targetSize": {
"$ref": "FixedOrPercent",
"description": "Specifies the intended number of instances to be created from the instanceTemplate. The final number of instances created from the template will be equal to: \n- If expressed as a fixed number, the minimum of either targetSize.fixed or instanceGroupManager.targetSize is used. \n- if expressed as a percent, the targetSize would be (targetSize.percent/100 * InstanceGroupManager.targetSize) If there is a remainder, the number is rounded up. If unset, this version will update any remaining instances not updated by another version. Read Starting a canary update for more information."
}
},
"type": "object"
},
"InstanceGroupManagersAbandonInstancesRequest": {
"id": "InstanceGroupManagersAbandonInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersApplyUpdatesRequest": {
"description": "InstanceGroupManagers.applyUpdatesToInstances",
"id": "InstanceGroupManagersApplyUpdatesRequest",
"properties": {
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
},
"minimalAction": {
"description": "The minimal action that you want to perform on each instance during the update: \n- REPLACE: At minimum, delete the instance and create it again. \n- RESTART: Stop the instance and start it again. \n- REFRESH: Do not stop the instance. \n- NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "The most disruptive action that you want to perform on each instance during the update: \n- REPLACE: Delete the instance and create it again. \n- RESTART: Stop the instance and start it again. \n- REFRESH: Do not stop the instance. \n- NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersCreateInstancesRequest": {
"description": "InstanceGroupManagers.createInstances",
"id": "InstanceGroupManagersCreateInstancesRequest",
"properties": {
"instances": {
"description": "[Required] List of specifications of per-instance configs.",
"items": {
"$ref": "PerInstanceConfig"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersDeleteInstancesRequest": {
"id": "InstanceGroupManagersDeleteInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersListErrorsResponse": {
"id": "InstanceGroupManagersListErrorsResponse",
"properties": {
"items": {
"description": "[Output Only] The list of errors of the managed instance group.",
"items": {
"$ref": "InstanceManagedByIgmError"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersListManagedInstancesResponse": {
"id": "InstanceGroupManagersListManagedInstancesResponse",
"properties": {
"managedInstances": {
"description": "[Output Only] The list of instances in the managed instance group.",
"items": {
"$ref": "ManagedInstance"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersRecreateInstancesRequest": {
"id": "InstanceGroupManagersRecreateInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersScopedList": {
"id": "InstanceGroupManagersScopedList",
"properties": {
"instanceGroupManagers": {
"description": "[Output Only] The list of managed instance groups that are contained in the specified project and zone.",
"items": {
"$ref": "InstanceGroupManager"
},
"type": "array"
},
"warning": {
"description": "[Output Only] The warning that replaces the list of managed instance groups when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagersSetInstanceTemplateRequest": {
"id": "InstanceGroupManagersSetInstanceTemplateRequest",
"properties": {
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersSetTargetPoolsRequest": {
"id": "InstanceGroupManagersSetTargetPoolsRequest",
"properties": {
"fingerprint": {
"description": "The fingerprint of the target pools information. Use this optional property to prevent conflicts when multiple users change the target pools settings concurrently. Obtain the fingerprint with the instanceGroupManagers.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
"format": "byte",
"type": "string"
},
"targetPools": {
"description": "The list of target pool URLs that instances in this managed instance group belong to. The managed instance group applies these target pools to all of the instances in the group. Existing instances and new instances in the group all receive these target pool settings.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupsAddInstancesRequest": {
"id": "InstanceGroupsAddInstancesRequest",
"properties": {
"instances": {
"description": "The list of instances to add to the instance group.",
"items": {
"$ref": "InstanceReference"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupsListInstances": {
"id": "InstanceGroupsListInstances",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceWithNamedPorts resources.",
"items": {
"$ref": "InstanceWithNamedPorts"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupsListInstances",
"description": "[Output Only] The resource type, which is always compute#instanceGroupsListInstances for the list of instances in the specified instance group.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupsListInstancesRequest": {
"id": "InstanceGroupsListInstancesRequest",
"properties": {
"instanceState": {
"description": "A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state.",
"enum": [
"ALL",
"RUNNING"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupsRemoveInstancesRequest": {
"id": "InstanceGroupsRemoveInstancesRequest",
"properties": {
"instances": {
"description": "The list of instances to remove from the instance group.",
"items": {
"$ref": "InstanceReference"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupsScopedList": {
"id": "InstanceGroupsScopedList",
"properties": {
"instanceGroups": {
"description": "[Output Only] The list of instance groups that are contained in this scope.",
"items": {
"$ref": "InstanceGroup"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that replaces the list of instance groups when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceGroupsSetNamedPortsRequest": {
"id": "InstanceGroupsSetNamedPortsRequest",
"properties": {
"fingerprint": {
"description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet.",
"format": "byte",
"type": "string"
},
"namedPorts": {
"description": "The list of named ports to set for this instance group.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
}
},
"type": "object"
},
"InstanceList": {
"description": "Contains a list of instances.",
"id": "InstanceList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Instance resources.",
"items": {
"$ref": "Instance"
},
"type": "array"
},
"kind": {
"default": "compute#instanceList",
"description": "[Output Only] Type of resource. Always compute#instanceList for lists of Instance resources.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceListReferrers": {
"description": "Contains a list of instance referrers.",
"id": "InstanceListReferrers",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Reference resources.",
"items": {
"$ref": "Reference"
},
"type": "array"
},
"kind": {
"default": "compute#instanceListReferrers",
"description": "[Output Only] Type of resource. Always compute#instanceListReferrers for lists of Instance referrers.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceManagedByIgmError": {
"id": "InstanceManagedByIgmError",
"properties": {
"error": {
"$ref": "InstanceManagedByIgmErrorManagedInstanceError",
"description": "[Output Only] Contents of the error."
},
"instanceActionDetails": {
"$ref": "InstanceManagedByIgmErrorInstanceActionDetails",
"description": "[Output Only] Details of the instance action that triggered this error. May be null, if the error was not caused by an action on an instance. This field is optional."
},
"timestamp": {
"description": "[Output Only] The time that this error occurred. This value is in RFC3339 text format.",
"type": "string"
}
},
"type": "object"
},
"InstanceManagedByIgmErrorInstanceActionDetails": {
"id": "InstanceManagedByIgmErrorInstanceActionDetails",
"properties": {
"action": {
"description": "[Output Only] Action that managed instance group was executing on the instance when the error occurred. Possible values:",
"enum": [
"ABANDONING",
"CREATING",
"CREATING_WITHOUT_RETRIES",
"DELETING",
"NONE",
"RECREATING",
"REFRESHING",
"RESTARTING",
"VERIFYING"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"instance": {
"description": "[Output Only] The URL of the instance. The URL can be set even if the instance has not yet been created.",
"type": "string"
},
"version": {
"$ref": "ManagedInstanceVersion",
"description": "[Output Only] Version this instance was created from, or was being created from, but the creation failed. Corresponds to one of the versions that were set on the Instance Group Manager resource at the time this instance was being created."
}
},
"type": "object"
},
"InstanceManagedByIgmErrorManagedInstanceError": {
"id": "InstanceManagedByIgmErrorManagedInstanceError",
"properties": {
"code": {
"description": "[Output Only] Error code.",
"type": "string"
},
"message": {
"description": "[Output Only] Error message.",
"type": "string"
}
},
"type": "object"
},
"InstanceMoveRequest": {
"id": "InstanceMoveRequest",
"properties": {
"destinationZone": {
"description": "The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone \n- projects/project/zones/zone \n- zones/zone",
"type": "string"
},
"targetInstance": {
"description": "The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance",
"type": "string"
}
},
"type": "object"
},
"InstanceProperties": {
"description": "",
"id": "InstanceProperties",
"properties": {
"canIpForward": {
"description": "Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information.",
"type": "boolean"
},
"description": {
"description": "An optional text description for the instances that are created from this instance template.",
"type": "string"
},
"disks": {
"description": "An array of disks that are associated with the instances that are created from this template.",
"items": {
"$ref": "AttachedDisk"
},
"type": "array"
},
"guestAccelerators": {
"description": "A list of guest accelerator cards' type and count to use for instances created from the instance template.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to instances that are created from this template.",
"type": "object"
},
"machineType": {
"annotations": {
"required": [
"compute.instanceTemplates.insert"
]
},
"description": "The machine type to use for instances that are created from this template.",
"type": "string"
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information."
},
"minCpuPlatform": {
"description": "Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: \"Intel Haswell\" or minCpuPlatform: \"Intel Sandy Bridge\". For more information, read Specifying a Minimum CPU Platform.",
"type": "string"
},
"networkInterfaces": {
"description": "An array of network access configurations for this interface.",
"items": {
"$ref": "NetworkInterface"
},
"type": "array"
},
"privateIpv6GoogleAccess": {
"description": "The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.",
"enum": [
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
"INHERIT_FROM_SUBNETWORK"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"reservationAffinity": {
"$ref": "ReservationAffinity",
"description": "Specifies the reservations that this instance can consume from."
},
"resourcePolicies": {
"description": "Resource policies (names, not ULRs) applied to instances created from this template.",
"items": {
"type": "string"
},
"type": "array"
},
"scheduling": {
"$ref": "Scheduling",
"description": "Specifies the scheduling options for the instances that are created from this template."
},
"serviceAccounts": {
"description": "A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig"
},
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035."
}
},
"type": "object"
},
"InstanceReference": {
"id": "InstanceReference",
"properties": {
"instance": {
"description": "The URL for a specific instance.",
"type": "string"
}
},
"type": "object"
},
"InstanceTemplate": {
"description": "Represents an Instance Template resource.\n\nYou can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. (== resource_for {$api_version}.instanceTemplates ==)",
"id": "InstanceTemplate",
"properties": {
"creationTimestamp": {
"description": "[Output Only] The creation timestamp for this instance template in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] A unique identifier for this instance template. The server defines this identifier.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#instanceTemplate",
"description": "[Output Only] The resource type, which is always compute#instanceTemplate for instance templates.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceTemplates.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"properties": {
"$ref": "InstanceProperties",
"description": "The instance properties for this instance template."
},
"selfLink": {
"description": "[Output Only] The URL for this instance template. The server defines this URL.",
"type": "string"
},
"sourceInstance": {
"description": "The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance",
"type": "string"
},
"sourceInstanceParams": {
"$ref": "SourceInstanceParams",
"description": "The source instance params to use to create this instance template."
}
},
"type": "object"
},
"InstanceTemplateList": {
"description": "A list of instance templates.",
"id": "InstanceTemplateList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceTemplate resources.",
"items": {
"$ref": "InstanceTemplate"
},
"type": "array"
},
"kind": {
"default": "compute#instanceTemplateList",
"description": "[Output Only] The resource type, which is always compute#instanceTemplatesListResponse for instance template lists.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstanceWithNamedPorts": {
"id": "InstanceWithNamedPorts",
"properties": {
"instance": {
"description": "[Output Only] The URL of the instance.",
"type": "string"
},
"namedPorts": {
"description": "[Output Only] The named ports that belong to this instance group.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
},
"status": {
"description": "[Output Only] The status of the instance.",
"enum": [
"DEPROVISIONING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InstancesAddResourcePoliciesRequest": {
"id": "InstancesAddResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be added to this instance.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstancesRemoveResourcePoliciesRequest": {
"id": "InstancesRemoveResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be removed from this instance.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstancesScopedList": {
"id": "InstancesScopedList",
"properties": {
"instances": {
"description": "[Output Only] A list of instances contained in this scope.",
"items": {
"$ref": "Instance"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of instances when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InstancesSetLabelsRequest": {
"id": "InstancesSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"InstancesSetMachineResourcesRequest": {
"id": "InstancesSetMachineResourcesRequest",
"properties": {
"guestAccelerators": {
"description": "A list of the type and count of accelerator cards attached to the instance.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
}
},
"type": "object"
},
"InstancesSetMachineTypeRequest": {
"id": "InstancesSetMachineTypeRequest",
"properties": {
"machineType": {
"description": "Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1",
"type": "string"
}
},
"type": "object"
},
"InstancesSetMinCpuPlatformRequest": {
"id": "InstancesSetMinCpuPlatformRequest",
"properties": {
"minCpuPlatform": {
"description": "Minimum cpu/platform this instance should be started at.",
"type": "string"
}
},
"type": "object"
},
"InstancesSetServiceAccountRequest": {
"id": "InstancesSetServiceAccountRequest",
"properties": {
"email": {
"description": "Email address of the service account.",
"type": "string"
},
"scopes": {
"description": "The list of scopes to be made available for this service account.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstancesStartWithEncryptionKeyRequest": {
"id": "InstancesStartWithEncryptionKeyRequest",
"properties": {
"disks": {
"description": "Array of disks associated with this instance that are protected with a customer-supplied encryption key.\n\nIn order to start the instance, the disk url and its corresponding key must be provided.\n\nIf the disk is not protected with a customer-supplied encryption key it should not be specified.",
"items": {
"$ref": "CustomerEncryptionKeyProtectedDisk"
},
"type": "array"
}
},
"type": "object"
},
"Int64RangeMatch": {
"description": "HttpRouteRuleMatch criteria for field values that must stay within the specified integer range.",
"id": "Int64RangeMatch",
"properties": {
"rangeEnd": {
"description": "The end of the range (exclusive) in signed long integer format.",
"format": "int64",
"type": "string"
},
"rangeStart": {
"description": "The start of the range (inclusive) in signed long integer format.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Interconnect": {
"description": "Represents an Interconnect resource.\n\nAn Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for {$api_version}.interconnects ==)",
"id": "Interconnect",
"properties": {
"adminEnabled": {
"description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.",
"type": "boolean"
},
"circuitInfos": {
"description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.",
"items": {
"$ref": "InterconnectCircuitInfo"
},
"type": "array"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"customerName": {
"description": "Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"expectedOutages": {
"description": "[Output Only] A list of outages expected for this Interconnect.",
"items": {
"$ref": "InterconnectOutageNotification"
},
"type": "array"
},
"googleIpAddress": {
"description": "[Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests.",
"type": "string"
},
"googleReferenceId": {
"description": "[Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"interconnectAttachments": {
"description": "[Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect.",
"items": {
"type": "string"
},
"type": "array"
},
"interconnectType": {
"description": "Type of interconnect, which can take one of the following values: \n- PARTNER: A partner-managed interconnection shared between customers though a partner. \n- DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED.",
"enum": [
"DEDICATED",
"IT_PRIVATE",
"PARTNER"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#interconnect",
"description": "[Output Only] Type of the resource. Always compute#interconnect for interconnects.",
"type": "string"
},
"linkType": {
"description": "Type of link requested, which can take one of the following values: \n- LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics \n- LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle.",
"enum": [
"LINK_TYPE_ETHERNET_100G_LR",
"LINK_TYPE_ETHERNET_10G_LR"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"location": {
"description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.interconnects.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"nocContactEmail": {
"description": "Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Stackdriver logs alerting and Cloud Notifications.",
"type": "string"
},
"operationalStatus": {
"description": "[Output Only] The current status of this Interconnect's functionality, which can take one of the following values: \n- OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. \n- OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. \n- OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
"enum": [
"OS_ACTIVE",
"OS_UNPROVISIONED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"peerIpAddress": {
"description": "[Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests.",
"type": "string"
},
"provisionedLinkCount": {
"description": "[Output Only] Number of links actually provisioned in this interconnect.",
"format": "int32",
"type": "integer"
},
"requestedLinkCount": {
"description": "Target number of physical links in the link bundle, as requested by the customer.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"state": {
"description": "[Output Only] The current state of Interconnect functionality, which can take one of the following values: \n- ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. \n- UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. \n- UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect.",
"enum": [
"ACTIVE",
"UNPROVISIONED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachment": {
"description": "Represents an Interconnect Attachment (VLAN) resource.\n\nYou can use Interconnect attachments (VLANS) to connect your Virtual Private Cloud networks to your on-premises networks through an Interconnect. For more information, read Creating VLAN Attachments. (== resource_for {$api_version}.interconnectAttachments ==)",
"id": "InterconnectAttachment",
"properties": {
"adminEnabled": {
"description": "Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER.",
"type": "boolean"
},
"bandwidth": {
"description": "Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: \n- BPS_50M: 50 Mbit/s \n- BPS_100M: 100 Mbit/s \n- BPS_200M: 200 Mbit/s \n- BPS_300M: 300 Mbit/s \n- BPS_400M: 400 Mbit/s \n- BPS_500M: 500 Mbit/s \n- BPS_1G: 1 Gbit/s \n- BPS_2G: 2 Gbit/s \n- BPS_5G: 5 Gbit/s \n- BPS_10G: 10 Gbit/s \n- BPS_20G: 20 Gbit/s \n- BPS_50G: 50 Gbit/s",
"enum": [
"BPS_100M",
"BPS_10G",
"BPS_1G",
"BPS_200M",
"BPS_20G",
"BPS_2G",
"BPS_300M",
"BPS_400M",
"BPS_500M",
"BPS_50G",
"BPS_50M",
"BPS_5G"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"candidateSubnets": {
"description": "Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space.",
"items": {
"type": "string"
},
"type": "array"
},
"cloudRouterIpAddress": {
"description": "[Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"customerRouterIpAddress": {
"description": "[Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment.",
"type": "string"
},
"description": {
"description": "An optional description of this resource.",
"type": "string"
},
"edgeAvailabilityDomain": {
"description": "Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: \n- AVAILABILITY_DOMAIN_ANY \n- AVAILABILITY_DOMAIN_1 \n- AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY.",
"enum": [
"AVAILABILITY_DOMAIN_1",
"AVAILABILITY_DOMAIN_2",
"AVAILABILITY_DOMAIN_ANY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"googleReferenceId": {
"description": "[Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"interconnect": {
"description": "URL of the underlying Interconnect object that this attachment's traffic will traverse through.",
"type": "string"
},
"kind": {
"default": "compute#interconnectAttachment",
"description": "[Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"operationalStatus": {
"description": "[Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: \n- OS_ACTIVE: The attachment has been turned up and is ready to use. \n- OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete.",
"enum": [
"OS_ACTIVE",
"OS_UNPROVISIONED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"pairingKey": {
"description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form \"XXXXX/region/domain\"",
"type": "string"
},
"partnerAsn": {
"description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED.",
"format": "int64",
"type": "string"
},
"partnerMetadata": {
"$ref": "InterconnectAttachmentPartnerMetadata",
"description": "Informational metadata about Partner attachments from Partners to display to customers. Output only for for PARTNER type, mutable for PARTNER_PROVIDER, not available for DEDICATED."
},
"privateInterconnectInfo": {
"$ref": "InterconnectAttachmentPrivateInfo",
"description": "[Output Only] Information specific to an InterconnectAttachment. This property is populated if the interconnect that this is attached to is of type DEDICATED."
},
"region": {
"description": "[Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"router": {
"description": "URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network \u0026 region within which the Cloud Router is configured.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"state": {
"description": "[Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: \n- ACTIVE: The attachment has been turned up and is ready to use. \n- UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. \n- PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. \n- PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. \n- PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. \n- DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted.",
"enum": [
"ACTIVE",
"DEFUNCT",
"PARTNER_REQUEST_RECEIVED",
"PENDING_CUSTOMER",
"PENDING_PARTNER",
"STATE_UNSPECIFIED",
"UNPROVISIONED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"type": {
"description": "The type of interconnect attachment this is, which can take one of the following values: \n- DEDICATED: an attachment to a Dedicated Interconnect. \n- PARTNER: an attachment to a Partner Interconnect, created by the customer. \n- PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner.",
"enum": [
"DEDICATED",
"PARTNER",
"PARTNER_PROVIDER"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"vlanTag8021q": {
"description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4094. Only specified at creation time.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectAttachmentAggregatedList": {
"id": "InterconnectAttachmentAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InterconnectAttachmentsScopedList",
"description": "Name of the scope containing this set of interconnect attachments."
},
"description": "A list of InterconnectAttachmentsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#interconnectAttachmentAggregatedList",
"description": "[Output Only] Type of resource. Always compute#interconnectAttachmentAggregatedList for aggregated lists of interconnect attachments.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InterconnectAttachmentList": {
"description": "Response to the list request, and contains a list of interconnect attachments.",
"id": "InterconnectAttachmentList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InterconnectAttachment resources.",
"items": {
"$ref": "InterconnectAttachment"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectAttachmentList",
"description": "[Output Only] Type of resource. Always compute#interconnectAttachmentList for lists of interconnect attachments.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InterconnectAttachmentPartnerMetadata": {
"description": "Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments.",
"id": "InterconnectAttachmentPartnerMetadata",
"properties": {
"interconnectName": {
"description": "Plain text name of the Interconnect this attachment is connected to, as displayed in the Partner's portal. For instance \"Chicago 1\". This value may be validated to match approved Partner values.",
"type": "string"
},
"partnerName": {
"description": "Plain text name of the Partner providing this attachment. This value may be validated to match approved Partner values.",
"type": "string"
},
"portalUrl": {
"description": "URL of the Partner's portal for this Attachment. Partners may customise this to be a deep link to the specific resource on the Partner portal. This value may be validated to match approved Partner values.",
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentPrivateInfo": {
"description": "Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED.",
"id": "InterconnectAttachmentPrivateInfo",
"properties": {
"tag8021q": {
"description": "[Output Only] 802.1q encapsulation tag to be used for traffic between Google and the customer, going to and from this network and region.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectAttachmentsScopedList": {
"id": "InterconnectAttachmentsScopedList",
"properties": {
"interconnectAttachments": {
"description": "A list of interconnect attachments contained in this scope.",
"items": {
"$ref": "InterconnectAttachment"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InterconnectCircuitInfo": {
"description": "Describes a single physical circuit between the Customer and Google. CircuitInfo objects are created by Google, so all fields are output only. Next id: 4",
"id": "InterconnectCircuitInfo",
"properties": {
"customerDemarcId": {
"description": "Customer-side demarc ID for this circuit.",
"type": "string"
},
"googleCircuitId": {
"description": "Google-assigned unique ID for this circuit. Assigned at circuit turn-up.",
"type": "string"
},
"googleDemarcId": {
"description": "Google-side demarc ID for this circuit. Assigned at circuit turn-up and provided by Google to the customer in the LOA.",
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnostics": {
"description": "Diagnostics information about interconnect, contains detailed and current technical information about Google's side of the connection.",
"id": "InterconnectDiagnostics",
"properties": {
"arpCaches": {
"description": "A list of InterconnectDiagnostics.ARPEntry objects, describing individual neighbors currently seen by the Google router in the ARP cache for the Interconnect. This will be empty when the Interconnect is not bundled.",
"items": {
"$ref": "InterconnectDiagnosticsARPEntry"
},
"type": "array"
},
"links": {
"description": "A list of InterconnectDiagnostics.LinkStatus objects, describing the status for each link on the Interconnect.",
"items": {
"$ref": "InterconnectDiagnosticsLinkStatus"
},
"type": "array"
},
"macAddress": {
"description": "The MAC address of the Interconnect's bundle interface.",
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnosticsARPEntry": {
"description": "Describing the ARP neighbor entries seen on this link",
"id": "InterconnectDiagnosticsARPEntry",
"properties": {
"ipAddress": {
"description": "The IP address of this ARP neighbor.",
"type": "string"
},
"macAddress": {
"description": "The MAC address of this ARP neighbor.",
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnosticsLinkLACPStatus": {
"id": "InterconnectDiagnosticsLinkLACPStatus",
"properties": {
"googleSystemId": {
"description": "System ID of the port on Google's side of the LACP exchange.",
"type": "string"
},
"neighborSystemId": {
"description": "System ID of the port on the neighbor's side of the LACP exchange.",
"type": "string"
},
"state": {
"description": "The state of a LACP link, which can take one of the following values: \n- ACTIVE: The link is configured and active within the bundle. \n- DETACHED: The link is not configured within the bundle. This means that the rest of the object should be empty.",
"enum": [
"ACTIVE",
"DETACHED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnosticsLinkOpticalPower": {
"id": "InterconnectDiagnosticsLinkOpticalPower",
"properties": {
"state": {
"description": "The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include: \n- OK: The value has not crossed a warning threshold. \n- LOW_WARNING: The value has crossed below the low warning threshold. \n- HIGH_WARNING: The value has crossed above the high warning threshold. \n- LOW_ALARM: The value has crossed below the low alarm threshold. \n- HIGH_ALARM: The value has crossed above the high alarm threshold.",
"enum": [
"HIGH_ALARM",
"HIGH_WARNING",
"LOW_ALARM",
"LOW_WARNING",
"OK"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"value": {
"description": "Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"InterconnectDiagnosticsLinkStatus": {
"id": "InterconnectDiagnosticsLinkStatus",
"properties": {
"arpCaches": {
"description": "A list of InterconnectDiagnostics.ARPEntry objects, describing the ARP neighbor entries seen on this link. This will be empty if the link is bundled",
"items": {
"$ref": "InterconnectDiagnosticsARPEntry"
},
"type": "array"
},
"circuitId": {
"description": "The unique ID for this link assigned during turn up by Google.",
"type": "string"
},
"googleDemarc": {
"description": "The Demarc address assigned by Google and provided in the LoA.",
"type": "string"
},
"lacpStatus": {
"$ref": "InterconnectDiagnosticsLinkLACPStatus"
},
"receivingOpticalPower": {
"$ref": "InterconnectDiagnosticsLinkOpticalPower",
"description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the received light level."
},
"transmittingOpticalPower": {
"$ref": "InterconnectDiagnosticsLinkOpticalPower",
"description": "An InterconnectDiagnostics.LinkOpticalPower object, describing the current value and status of the transmitted light level."
}
},
"type": "object"
},
"InterconnectList": {
"description": "Response to the list request, and contains a list of interconnects.",
"id": "InterconnectList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Interconnect resources.",
"items": {
"$ref": "Interconnect"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectList",
"description": "[Output Only] Type of resource. Always compute#interconnectList for lists of interconnects.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InterconnectLocation": {
"description": "Represents an Interconnect Attachment (VLAN) Location resource.\n\nYou can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments.",
"id": "InterconnectLocation",
"properties": {
"address": {
"description": "[Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character.",
"type": "string"
},
"availabilityZone": {
"description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".",
"type": "string"
},
"city": {
"description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".",
"type": "string"
},
"continent": {
"description": "[Output Only] Continent for this location, which can take one of the following values: \n- AFRICA \n- ASIA_PAC \n- EUROPE \n- NORTH_AMERICA \n- SOUTH_AMERICA",
"enum": [
"AFRICA",
"ASIA_PAC",
"C_AFRICA",
"C_ASIA_PAC",
"C_EUROPE",
"C_NORTH_AMERICA",
"C_SOUTH_AMERICA",
"EUROPE",
"NORTH_AMERICA",
"SOUTH_AMERICA"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "[Output Only] An optional description of the resource.",
"type": "string"
},
"facilityProvider": {
"description": "[Output Only] The name of the provider for this facility (e.g., EQUINIX).",
"type": "string"
},
"facilityProviderFacilityId": {
"description": "[Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1).",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#interconnectLocation",
"description": "[Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the resource.",
"type": "string"
},
"peeringdbFacilityId": {
"description": "[Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb).",
"type": "string"
},
"regionInfos": {
"description": "[Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions.",
"items": {
"$ref": "InterconnectLocationRegionInfo"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of this InterconnectLocation, which can take one of the following values: \n- CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. \n- AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects.",
"enum": [
"AVAILABLE",
"CLOSED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectLocationList": {
"description": "Response to the list request, and contains a list of interconnect locations.",
"id": "InterconnectLocationList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InterconnectLocation resources.",
"items": {
"$ref": "InterconnectLocation"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectLocationList",
"description": "[Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"InterconnectLocationRegionInfo": {
"description": "Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region.",
"id": "InterconnectLocationRegionInfo",
"properties": {
"expectedRttMs": {
"description": "Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region.",
"format": "int64",
"type": "string"
},
"locationPresence": {
"description": "Identifies the network presence of this location.",
"enum": [
"GLOBAL",
"LOCAL_REGION",
"LP_GLOBAL",
"LP_LOCAL_REGION"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"region": {
"description": "URL for the region of this location.",
"type": "string"
}
},
"type": "object"
},
"InterconnectOutageNotification": {
"description": "Description of a planned outage on this Interconnect. Next id: 9",
"id": "InterconnectOutageNotification",
"properties": {
"affectedCircuits": {
"description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit IDs that will be affected.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "A description about the purpose of the outage.",
"type": "string"
},
"endTime": {
"description": "Scheduled end time for the outage (milliseconds since Unix epoch).",
"format": "int64",
"type": "string"
},
"issueType": {
"description": "Form this outage is expected to take, which can take one of the following values: \n- OUTAGE: The Interconnect may be completely out of service for some or all of the specified window. \n- PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole should remain up, but with reduced bandwidth. Note that the versions of this enum prefixed with \"IT_\" have been deprecated in favor of the unprefixed values.",
"enum": [
"IT_OUTAGE",
"IT_PARTIAL_OUTAGE",
"OUTAGE",
"PARTIAL_OUTAGE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"name": {
"description": "Unique identifier for this outage notification.",
"type": "string"
},
"source": {
"description": "The party that generated this notification, which can take the following value: \n- GOOGLE: this notification as generated by Google. Note that the value of NSRC_GOOGLE has been deprecated in favor of GOOGLE.",
"enum": [
"GOOGLE",
"NSRC_GOOGLE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"startTime": {
"description": "Scheduled start time for the outage (milliseconds since Unix epoch).",
"format": "int64",
"type": "string"
},
"state": {
"description": "State of this notification, which can take one of the following values: \n- ACTIVE: This outage notification is active. The event could be in the past, present, or future. See start_time and end_time for scheduling. \n- CANCELLED: The outage associated with this notification was cancelled before the outage was due to start. Note that the versions of this enum prefixed with \"NS_\" have been deprecated in favor of the unprefixed values.",
"enum": [
"ACTIVE",
"CANCELLED",
"COMPLETED",
"NS_ACTIVE",
"NS_CANCELED"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectsGetDiagnosticsResponse": {
"description": "Response for the InterconnectsGetDiagnosticsRequest.",
"id": "InterconnectsGetDiagnosticsResponse",
"properties": {
"result": {
"$ref": "InterconnectDiagnostics"
}
},
"type": "object"
},
"License": {
"description": "Represents a License resource.\n\nA License represents billing and aggregate usage data for public and marketplace images. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenses ==)",
"id": "License",
"properties": {
"chargesUseFee": {
"description": "[Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee.",
"type": "boolean"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional textual description of the resource; provided by the client when the resource is created.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#license",
"description": "[Output Only] Type of resource. Always compute#license for licenses.",
"type": "string"
},
"licenseCode": {
"description": "[Output Only] The unique code used to attach this license to images, snapshots, and disks.",
"format": "uint64",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.images.insert"
]
},
"description": "Name of the resource. The name must be 1-63 characters long and comply with RFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"resourceRequirements": {
"$ref": "LicenseResourceRequirements"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"transferable": {
"description": "If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk.",
"type": "boolean"
}
},
"type": "object"
},
"LicenseCode": {
"description": "Represents a License Code resource.\n\nA License Code is a unique identifier used to represent a license resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenseCodes ==)",
"id": "LicenseCode",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "[Output Only] Description of this License Code.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#licenseCode",
"description": "[Output Only] Type of resource. Always compute#licenseCode for licenses.",
"type": "string"
},
"licenseAlias": {
"description": "[Output Only] URL and description aliases of Licenses with the same License Code.",
"items": {
"$ref": "LicenseCodeLicenseAlias"
},
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.licenses.insert"
]
},
"description": "[Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.",
"pattern": "[0-9]{0,20}?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"state": {
"description": "[Output Only] Current state of this License Code.",
"enum": [
"DISABLED",
"ENABLED",
"RESTRICTED",
"STATE_UNSPECIFIED",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"transferable": {
"description": "[Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.",
"type": "boolean"
}
},
"type": "object"
},
"LicenseCodeLicenseAlias": {
"id": "LicenseCodeLicenseAlias",
"properties": {
"description": {
"description": "[Output Only] Description of this License Code.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] URL of license corresponding to this License Code.",
"type": "string"
}
},
"type": "object"
},
"LicenseResourceRequirements": {
"id": "LicenseResourceRequirements",
"properties": {
"minGuestCpuCount": {
"description": "Minimum number of guest cpus required to use the Instance. Enforced at Instance creation and Instance start.",
"format": "int32",
"type": "integer"
},
"minMemoryMb": {
"description": "Minimum memory required to use the Instance. Enforced at Instance creation and Instance start.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"LicensesListResponse": {
"id": "LicensesListResponse",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of License resources.",
"items": {
"$ref": "License"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"LogConfig": {
"description": "Specifies what kind of log the caller must write",
"id": "LogConfig",
"properties": {
"cloudAudit": {
"$ref": "LogConfigCloudAuditOptions",
"description": "Cloud audit options."
},
"counter": {
"$ref": "LogConfigCounterOptions",
"description": "Counter options."
},
"dataAccess": {
"$ref": "LogConfigDataAccessOptions",
"description": "Data access options."
}
},
"type": "object"
},
"LogConfigCloudAuditOptions": {
"description": "Write a Cloud Audit log",
"id": "LogConfigCloudAuditOptions",
"properties": {
"authorizationLoggingOptions": {
"$ref": "AuthorizationLoggingOptions",
"description": "Information used by the Cloud Audit Logging pipeline."
},
"logName": {
"description": "The log_name to populate in the Cloud Audit Record.",
"enum": [
"ADMIN_ACTIVITY",
"DATA_ACCESS",
"UNSPECIFIED_LOG_NAME"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"LogConfigCounterOptions": {
"description": "Increment a streamz counter with the specified metric and field names.\n\nMetric names should start with a '/', generally be lowercase-only, and end in \"_count\". Field names should not contain an initial slash. The actual exported metric names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM request parameters and field values are their respective values.\n\nSupported field names: - \"authority\", which is \"[token]\" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - \"iam_principal\", a representation of IAMContext.principal even if a token or authority selector is present; or - \"\" (empty string), resulting in a counter with no fields.\n\nExamples: counter { metric: \"/debug_access_count\" field: \"iam_principal\" } ==\u003e increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}",
"id": "LogConfigCounterOptions",
"properties": {
"customFields": {
"description": "Custom fields.",
"items": {
"$ref": "LogConfigCounterOptionsCustomField"
},
"type": "array"
},
"field": {
"description": "The field value to attribute.",
"type": "string"
},
"metric": {
"description": "The metric to update.",
"type": "string"
}
},
"type": "object"
},
"LogConfigCounterOptionsCustomField": {
"description": "Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.",
"id": "LogConfigCounterOptionsCustomField",
"properties": {
"name": {
"description": "Name is the field name.",
"type": "string"
},
"value": {
"description": "Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.",
"type": "string"
}
},
"type": "object"
},
"LogConfigDataAccessOptions": {
"description": "Write a Data Access (Gin) log",
"id": "LogConfigDataAccessOptions",
"properties": {
"logMode": {
"description": "",
"enum": [
"LOG_FAIL_CLOSED",
"LOG_MODE_UNSPECIFIED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"MachineType": {
"description": "Represents a Machine Type resource.\n\nYou can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for {$api_version}.machineTypes ==)",
"id": "MachineType",
"properties": {
"accelerators": {
"description": "[Output Only] A list of accelerator configurations assigned to this machine type.",
"items": {
"properties": {
"guestAcceleratorCount": {
"description": "Number of accelerator cards exposed to the guest.",
"format": "int32",
"type": "integer"
},
"guestAcceleratorType": {
"description": "The accelerator type resource name, not a full URL, e.g. 'nvidia-tesla-k80'.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this machine type."
},
"description": {
"description": "[Output Only] An optional textual description of the resource.",
"type": "string"
},
"guestCpus": {
"description": "[Output Only] The number of virtual CPUs that are available to the instance.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"imageSpaceGb": {
"description": "[Deprecated] This property is deprecated and will never be populated with any relevant values.",
"format": "int32",
"type": "integer"
},
"isSharedCpu": {
"description": "[Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.",
"type": "boolean"
},
"kind": {
"default": "compute#machineType",
"description": "[Output Only] The type of the resource. Always compute#machineType for machine types.",
"type": "string"
},
"maximumPersistentDisks": {
"description": "[Output Only] Maximum persistent disks allowed.",
"format": "int32",
"type": "integer"
},
"maximumPersistentDisksSizeGb": {
"description": "[Output Only] Maximum total persistent disks size (GB) allowed.",
"format": "int64",
"type": "string"
},
"memoryMb": {
"description": "[Output Only] The amount of physical memory available to the instance, defined in MB.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"scratchDisks": {
"description": "[Output Only] A list of extended scratch disks assigned to the instance.",
"items": {
"properties": {
"diskGb": {
"description": "Size of the scratch disk, defined in GB.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"zone": {
"description": "[Output Only] The name of the zone where the machine type resides, such as us-central1-a.",
"type": "string"
}
},
"type": "object"
},
"MachineTypeAggregatedList": {
"id": "MachineTypeAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "MachineTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of machine types."
},
"description": "A list of MachineTypesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#machineTypeAggregatedList",
"description": "[Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"MachineTypeList": {
"description": "Contains a list of machine types.",
"id": "MachineTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of MachineType resources.",
"items": {
"$ref": "MachineType"
},
"type": "array"
},
"kind": {
"default": "compute#machineTypeList",
"description": "[Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"MachineTypesScopedList": {
"id": "MachineTypesScopedList",
"properties": {
"machineTypes": {
"description": "[Output Only] A list of machine types contained in this scope.",
"items": {
"$ref": "MachineType"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that appears when the machine types list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ManagedInstance": {
"description": "A Managed Instance resource.",
"id": "ManagedInstance",
"properties": {
"currentAction": {
"description": "[Output Only] The current action that the managed instance group has scheduled for the instance. Possible values: \n- NONE The instance is running, and the managed instance group does not have any scheduled actions for this instance. \n- CREATING The managed instance group is creating this instance. If the group fails to create this instance, it will try again until it is successful. \n- CREATING_WITHOUT_RETRIES The managed instance group is attempting to create this instance only once. If the group fails to create this instance, it does not try again and the group's targetSize value is decreased instead. \n- RECREATING The managed instance group is recreating this instance. \n- DELETING The managed instance group is permanently deleting this instance. \n- ABANDONING The managed instance group is abandoning this instance. The instance will be removed from the instance group and from any target pools that are associated with this group. \n- RESTARTING The managed instance group is restarting the instance. \n- REFRESHING The managed instance group is applying configuration changes to the instance without stopping it. For example, the group can update the target pool list for an instance without stopping that instance. \n- VERIFYING The managed instance group has created the instance and it is in the process of being verified.",
"enum": [
"ABANDONING",
"CREATING",
"CREATING_WITHOUT_RETRIES",
"DELETING",
"NONE",
"RECREATING",
"REFRESHING",
"RESTARTING",
"VERIFYING"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"id": {
"description": "[Output only] The unique identifier for this resource. This field is empty when instance does not exist.",
"format": "uint64",
"type": "string"
},
"instance": {
"description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.",
"type": "string"
},
"instanceHealth": {
"description": "[Output Only] Health state of the instance per health-check.",
"items": {
"$ref": "ManagedInstanceInstanceHealth"
},
"type": "array"
},
"instanceStatus": {
"description": "[Output Only] The status of the instance. This field is empty when the instance does not exist.",
"enum": [
"DEPROVISIONING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"lastAttempt": {
"$ref": "ManagedInstanceLastAttempt",
"description": "[Output Only] Information about the last attempt to create or delete the instance."
},
"version": {
"$ref": "ManagedInstanceVersion",
"description": "[Output Only] Intended version of this instance."
}
},
"type": "object"
},
"ManagedInstanceInstanceHealth": {
"id": "ManagedInstanceInstanceHealth",
"properties": {
"detailedHealthState": {
"description": "[Output Only] The current detailed instance health state.",
"enum": [
"DRAINING",
"HEALTHY",
"TIMEOUT",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"healthCheck": {
"description": "[Output Only] The URL for the health check that verifies whether the instance is healthy.",
"type": "string"
}
},
"type": "object"
},
"ManagedInstanceLastAttempt": {
"id": "ManagedInstanceLastAttempt",
"properties": {
"errors": {
"description": "[Output Only] Encountered errors during the last attempt to create or delete the instance.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this operation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"ManagedInstanceVersion": {
"id": "ManagedInstanceVersion",
"properties": {
"instanceTemplate": {
"description": "[Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING }.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the version.",
"type": "string"
}
},
"type": "object"
},
"Metadata": {
"description": "A metadata key/value entry.",
"id": "Metadata",
"properties": {
"fingerprint": {
"description": "Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve the resource.",
"format": "byte",
"type": "string"
},
"items": {
"description": "Array of key/value pairs. The total size of all keys and values must be less than 512 KB.",
"items": {
"properties": {
"key": {
"annotations": {
"required": [
"compute.instances.insert",
"compute.projects.setCommonInstanceMetadata"
]
},
"description": "Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.",
"pattern": "[a-zA-Z0-9-_]{1,128}",
"type": "string"
},
"value": {
"annotations": {
"required": [
"compute.instances.insert",
"compute.projects.setCommonInstanceMetadata"
]
},
"description": "Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB).",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"kind": {
"default": "compute#metadata",
"description": "[Output Only] Type of the resource. Always compute#metadata for metadata.",
"type": "string"
}
},
"type": "object"
},
"MetadataFilter": {
"description": "Opaque filter criteria used by loadbalancers to restrict routing configuration to a limited set of loadbalancing proxies. Proxies and sidecars involved in loadbalancing would typically present metadata to the loadbalancers which need to match criteria specified here. If a match takes place, the relevant configuration is made available to those proxies.\nFor each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata.\nAn example for using metadataFilters would be: if loadbalancing involves Envoys, they will only receive routing configuration when values in metadataFilters match values supplied in \u003ca href=\"https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/core/base.proto#envoy-api-msg-core-node\" Node metadata of their XDS requests to loadbalancers.",
"id": "MetadataFilter",
"properties": {
"filterLabels": {
"description": "The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria \nThis list must not be empty and can have at the most 64 entries.",
"items": {
"$ref": "MetadataFilterLabelMatch"
},
"type": "array"
},
"filterMatchCriteria": {
"description": "Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match.\nSupported values are: \n- MATCH_ANY: At least one of the filterLabels must have a matching label in the provided metadata. \n- MATCH_ALL: All filterLabels must have matching labels in the provided metadata.",
"enum": [
"MATCH_ALL",
"MATCH_ANY",
"NOT_SET"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"MetadataFilterLabelMatch": {
"description": "MetadataFilter label name value pairs that are expected to match corresponding labels presented as metadata to the loadbalancer.",
"id": "MetadataFilterLabelMatch",
"properties": {
"name": {
"description": "Name of metadata label.\nThe name can have a maximum length of 1024 characters and must be at least 1 character long.",
"type": "string"
},
"value": {
"description": "The value of the label must match the specified value.\nvalue can have a maximum length of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"NamedPort": {
"description": "The named port. For example: .",
"id": "NamedPort",
"properties": {
"name": {
"description": "The name for this named port. The name must be 1-63 characters long, and comply with RFC1035.",
"type": "string"
},
"port": {
"description": "The port number, which can be a value between 1 and 65535.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Network": {
"description": "Represents a VPC Network resource.\n\nNetworks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.networks ==)",
"id": "Network",
"properties": {
"IPv4Range": {
"description": "Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created.",
"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}",
"type": "string"
},
"autoCreateSubnetworks": {
"description": "When set to true, the VPC network is created in \"auto\" mode. When set to false, the VPC network is created in \"custom\" mode.\n\nAn auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges.",
"type": "boolean"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you create the resource.",
"type": "string"
},
"gatewayIPv4": {
"description": "[Output Only] The gateway address for default routing out of the network, selected by GCP.",
"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#network",
"description": "[Output Only] Type of the resource. Always compute#network for networks.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.networks.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"peerings": {
"description": "[Output Only] A list of network peerings for the resource.",
"items": {
"$ref": "NetworkPeering"
},
"type": "array"
},
"routingConfig": {
"$ref": "NetworkRoutingConfig",
"description": "The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce."
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"subnetworks": {
"description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NetworkEndpoint": {
"description": "The network endpoint. Next ID: 7",
"id": "NetworkEndpoint",
"properties": {
"fqdn": {
"description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.",
"type": "string"
},
"instance": {
"description": "The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.\n\nThe name must be 1-63 characters long, and comply with RFC1035.",
"type": "string"
},
"ipAddress": {
"description": "Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.",
"type": "string"
},
"port": {
"description": "Optional port number of network endpoint. If not specified and the NetworkEndpointGroup.network_endpoint_type is GCE_IP_PORT, the defaultPort for the network endpoint group will be used.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"NetworkEndpointGroup": {
"description": "Represents a collection of network endpoints.\n\nA network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up internet NEGs or Setting up zonal NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==)",
"id": "NetworkEndpointGroup",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultPort": {
"description": "The default port used if the port number is not specified in the network endpoint.",
"format": "int32",
"type": "integer"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#networkEndpointGroup",
"description": "[Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.",
"type": "string"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"type": "string"
},
"network": {
"description": "The URL of the network to which all network endpoints in the NEG belong. Uses \"default\" project network if unspecified.",
"type": "string"
},
"networkEndpointType": {
"description": "Type of network endpoints in this network endpoint group.",
"enum": [
"GCE_VM_IP_PORT",
"INTERNET_FQDN_PORT",
"INTERNET_IP_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"size": {
"description": "[Output only] Number of network endpoints in the network endpoint group.",
"format": "int32",
"type": "integer"
},
"subnetwork": {
"description": "Optional URL of the subnetwork to which all network endpoints in the NEG belong.",
"type": "string"
},
"zone": {
"description": "[Output Only] The URL of the zone where the network endpoint group is located.",
"type": "string"
}
},
"type": "object"
},
"NetworkEndpointGroupAggregatedList": {
"id": "NetworkEndpointGroupAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NetworkEndpointGroupsScopedList",
"description": "The name of the scope that contains this set of network endpoint groups."
},
"description": "A list of NetworkEndpointGroupsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#networkEndpointGroupAggregatedList",
"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NetworkEndpointGroupList": {
"id": "NetworkEndpointGroupList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NetworkEndpointGroup resources.",
"items": {
"$ref": "NetworkEndpointGroup"
},
"type": "array"
},
"kind": {
"default": "compute#networkEndpointGroupList",
"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NetworkEndpointGroupsAttachEndpointsRequest": {
"id": "NetworkEndpointGroupsAttachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be attached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"NetworkEndpointGroupsDetachEndpointsRequest": {
"id": "NetworkEndpointGroupsDetachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be detached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"NetworkEndpointGroupsListEndpointsRequest": {
"id": "NetworkEndpointGroupsListEndpointsRequest",
"properties": {
"healthStatus": {
"description": "Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.",
"enum": [
"SHOW",
"SKIP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworkEndpointGroupsListNetworkEndpoints": {
"id": "NetworkEndpointGroupsListNetworkEndpoints",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NetworkEndpointWithHealthStatus resources.",
"items": {
"$ref": "NetworkEndpointWithHealthStatus"
},
"type": "array"
},
"kind": {
"default": "compute#networkEndpointGroupsListNetworkEndpoints",
"description": "[Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NetworkEndpointGroupsScopedList": {
"id": "NetworkEndpointGroupsScopedList",
"properties": {
"networkEndpointGroups": {
"description": "[Output Only] The list of network endpoint groups that are contained in this scope.",
"items": {
"$ref": "NetworkEndpointGroup"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NetworkEndpointWithHealthStatus": {
"id": "NetworkEndpointWithHealthStatus",
"properties": {
"healths": {
"description": "[Output only] The health status of network endpoint;",
"items": {
"$ref": "HealthStatusForNetworkEndpoint"
},
"type": "array"
},
"networkEndpoint": {
"$ref": "NetworkEndpoint",
"description": "[Output only] The network endpoint;"
}
},
"type": "object"
},
"NetworkInterface": {
"description": "A network interface resource attached to an instance.",
"id": "NetworkInterface",
"properties": {
"accessConfigs": {
"description": "An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.",
"items": {
"$ref": "AccessConfig"
},
"type": "array"
},
"aliasIpRanges": {
"description": "An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.",
"items": {
"$ref": "AliasIpRange"
},
"type": "array"
},
"fingerprint": {
"description": "Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet.",
"format": "byte",
"type": "string"
},
"ipv6Address": {
"description": "[Output Only] An IPv6 internal network address for this network interface.",
"type": "string"
},
"kind": {
"default": "compute#networkInterface",
"description": "[Output Only] Type of the resource. Always compute#networkInterface for network interfaces.",
"type": "string"
},
"name": {
"description": "[Output Only] The name of the network interface, which is generated by the server. For network devices, these are eth0, eth1, etc.",
"type": "string"
},
"network": {
"description": "URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.\n\nIf you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/global/networks/network \n- projects/project/global/networks/network \n- global/networks/default",
"type": "string"
},
"networkIP": {
"description": "An IPv4 internal IP address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.",
"type": "string"
},
"subnetwork": {
"description": "The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n- regions/region/subnetworks/subnetwork",
"type": "string"
}
},
"type": "object"
},
"NetworkList": {
"description": "Contains a list of networks.",
"id": "NetworkList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Network resources.",
"items": {
"$ref": "Network"
},
"type": "array"
},
"kind": {
"default": "compute#networkList",
"description": "[Output Only] Type of resource. Always compute#networkList for lists of networks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NetworkPeering": {
"description": "A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering.",
"id": "NetworkPeering",
"properties": {
"autoCreateRoutes": {
"description": "This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
"type": "boolean"
},
"exchangeSubnetRoutes": {
"description": "Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
"type": "boolean"
},
"exportCustomRoutes": {
"description": "Whether to export the custom routes to peer network.",
"type": "boolean"
},
"exportSubnetRoutesWithPublicIp": {
"description": "Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field.",
"type": "boolean"
},
"importCustomRoutes": {
"description": "Whether to import the custom routes from peer network.",
"type": "boolean"
},
"importSubnetRoutesWithPublicIp": {
"description": "Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field.",
"type": "boolean"
},
"name": {
"description": "Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"type": "string"
},
"network": {
"description": "The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.",
"type": "string"
},
"state": {
"description": "[Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"stateDetails": {
"description": "[Output Only] Details about the current state of the peering.",
"type": "string"
}
},
"type": "object"
},
"NetworkRoutingConfig": {
"description": "A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide.",
"id": "NetworkRoutingConfig",
"properties": {
"routingMode": {
"description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.",
"enum": [
"GLOBAL",
"REGIONAL"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworksAddPeeringRequest": {
"id": "NetworksAddPeeringRequest",
"properties": {
"autoCreateRoutes": {
"description": "This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Indicates whether full mesh connectivity is created and managed automatically between peered networks. Currently this field should always be true since Google Compute Engine will automatically create and manage subnetwork routes between two networks when peering state is ACTIVE.",
"type": "boolean"
},
"name": {
"annotations": {
"required": [
"compute.networks.addPeering"
]
},
"description": "Name of the peering, which should conform to RFC1035.",
"type": "string"
},
"networkPeering": {
"$ref": "NetworkPeering",
"description": "Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon."
},
"peerNetwork": {
"description": "URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network.",
"type": "string"
}
},
"type": "object"
},
"NetworksRemovePeeringRequest": {
"id": "NetworksRemovePeeringRequest",
"properties": {
"name": {
"description": "Name of the peering, which should conform to RFC1035.",
"type": "string"
}
},
"type": "object"
},
"NetworksUpdatePeeringRequest": {
"id": "NetworksUpdatePeeringRequest",
"properties": {
"networkPeering": {
"$ref": "NetworkPeering"
}
},
"type": "object"
},
"NodeGroup": {
"description": "Represent a sole-tenant Node Group resource.\n\nA sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for {$api_version}.nodeGroups ==)",
"id": "NodeGroup",
"properties": {
"autoscalingPolicy": {
"$ref": "NodeGroupAutoscalingPolicy",
"description": "Specifies how autoscaling should behave."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"fingerprint": {
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#nodeGroup",
"description": "[Output Only] The type of the resource. Always compute#nodeGroup for node group.",
"type": "string"
},
"maintenancePolicy": {
"description": "Specifies how to handle instances when a node in the group undergoes maintenance.",
"enum": [
"DEFAULT",
"MAINTENANCE_POLICY_UNSPECIFIED",
"MIGRATE_WITHIN_NODE_GROUP",
"RESTART_IN_PLACE"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"name": {
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"type": "string"
},
"nodeTemplate": {
"description": "The URL of the node template to which this node group belongs.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"size": {
"description": "[Output Only] The total number of nodes in the node group.",
"format": "int32",
"type": "integer"
},
"status": {
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"zone": {
"description": "[Output Only] The name of the zone where the node group resides, such as us-central1-a.",
"type": "string"
}
},
"type": "object"
},
"NodeGroupAggregatedList": {
"id": "NodeGroupAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NodeGroupsScopedList",
"description": "[Output Only] Name of the scope containing this set of node groups."
},
"description": "A list of NodeGroupsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#nodeGroupAggregatedList",
"description": "[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeGroupAutoscalingPolicy": {
"id": "NodeGroupAutoscalingPolicy",
"properties": {
"maxNodes": {
"description": "The maximum number of nodes that the group should have.",
"format": "int32",
"type": "integer"
},
"minNodes": {
"description": "The minimum number of nodes that the group should have.",
"format": "int32",
"type": "integer"
},
"mode": {
"description": "The autoscaling mode.",
"enum": [
"MODE_UNSPECIFIED",
"OFF",
"ON",
"ONLY_SCALE_OUT"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NodeGroupList": {
"description": "Contains a list of nodeGroups.",
"id": "NodeGroupList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NodeGroup resources.",
"items": {
"$ref": "NodeGroup"
},
"type": "array"
},
"kind": {
"default": "compute#nodeGroupList",
"description": "[Output Only] Type of resource.Always compute#nodeGroupList for lists of node groups.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeGroupNode": {
"id": "NodeGroupNode",
"properties": {
"instances": {
"description": "Instances scheduled on this node.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name of the node.",
"type": "string"
},
"nodeType": {
"description": "The type of this node.",
"type": "string"
},
"serverBinding": {
"$ref": "ServerBinding",
"description": "Binding properties for the physical server."
},
"serverId": {
"description": "Server ID associated with this node.",
"type": "string"
},
"status": {
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY",
"REPAIRING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NodeGroupsAddNodesRequest": {
"id": "NodeGroupsAddNodesRequest",
"properties": {
"additionalNodeCount": {
"description": "Count of additional nodes to be added to the node group.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"NodeGroupsDeleteNodesRequest": {
"id": "NodeGroupsDeleteNodesRequest",
"properties": {
"nodes": {
"description": "Names of the nodes to delete.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NodeGroupsListNodes": {
"id": "NodeGroupsListNodes",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Node resources.",
"items": {
"$ref": "NodeGroupNode"
},
"type": "array"
},
"kind": {
"default": "compute#nodeGroupsListNodes",
"description": "[Output Only] The resource type, which is always compute.nodeGroupsListNodes for the list of nodes in the specified node group.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeGroupsScopedList": {
"id": "NodeGroupsScopedList",
"properties": {
"nodeGroups": {
"description": "[Output Only] A list of node groups contained in this scope.",
"items": {
"$ref": "NodeGroup"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that appears when the nodeGroup list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeGroupsSetNodeTemplateRequest": {
"id": "NodeGroupsSetNodeTemplateRequest",
"properties": {
"nodeTemplate": {
"description": "Full or partial URL of the node template resource to be updated for this node group.",
"type": "string"
}
},
"type": "object"
},
"NodeTemplate": {
"description": "Represent a sole-tenant Node Template resource.\n\nYou can use a template to define properties for nodes in a node group. For more information, read Creating node groups and instances. (== resource_for {$api_version}.nodeTemplates ==) (== NextID: 19 ==)",
"id": "NodeTemplate",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#nodeTemplate",
"description": "[Output Only] The type of the resource. Always compute#nodeTemplate for node templates.",
"type": "string"
},
"name": {
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"type": "string"
},
"nodeAffinityLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to use for node affinity, which will be used in instance scheduling.",
"type": "object"
},
"nodeType": {
"description": "The node type to use for nodes group that are created from this template.",
"type": "string"
},
"nodeTypeFlexibility": {
"$ref": "NodeTemplateNodeTypeFlexibility",
"description": "The flexible properties of the desired node type. Node groups that use this node template will create nodes of a type that matches these properties.\n\nThis field is mutually exclusive with the node_type property; you can only define one or the other, but not both."
},
"region": {
"description": "[Output Only] The name of the region where the node template resides, such as us-central1.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"serverBinding": {
"$ref": "ServerBinding",
"description": "Sets the binding properties for the physical server. Valid values include: \n- [Default] RESTART_NODE_ON_ANY_SERVER: Restarts VMs on any available physical server \n- RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same physical server whenever possible \n\nSee Sole-tenant node options for more information."
},
"status": {
"description": "[Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"statusMessage": {
"description": "[Output Only] An optional, human-readable explanation of the status.",
"type": "string"
}
},
"type": "object"
},
"NodeTemplateAggregatedList": {
"id": "NodeTemplateAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NodeTemplatesScopedList",
"description": "[Output Only] Name of the scope containing this set of node templates."
},
"description": "A list of NodeTemplatesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#nodeTemplateAggregatedList",
"description": "[Output Only] Type of resource.Always compute#nodeTemplateAggregatedList for aggregated lists of node templates.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeTemplateList": {
"description": "Contains a list of node templates.",
"id": "NodeTemplateList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NodeTemplate resources.",
"items": {
"$ref": "NodeTemplate"
},
"type": "array"
},
"kind": {
"default": "compute#nodeTemplateList",
"description": "[Output Only] Type of resource.Always compute#nodeTemplateList for lists of node templates.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeTemplateNodeTypeFlexibility": {
"id": "NodeTemplateNodeTypeFlexibility",
"properties": {
"cpus": {
"type": "string"
},
"localSsd": {
"type": "string"
},
"memory": {
"type": "string"
}
},
"type": "object"
},
"NodeTemplatesScopedList": {
"id": "NodeTemplatesScopedList",
"properties": {
"nodeTemplates": {
"description": "[Output Only] A list of node templates contained in this scope.",
"items": {
"$ref": "NodeTemplate"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that appears when the node templates list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeType": {
"description": "Represent a sole-tenant Node Type resource.\n\nEach node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for {$api_version}.nodeTypes ==)",
"id": "NodeType",
"properties": {
"cpuPlatform": {
"description": "[Output Only] The CPU platform used by this node type.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this node type."
},
"description": {
"description": "[Output Only] An optional textual description of the resource.",
"type": "string"
},
"guestCpus": {
"description": "[Output Only] The number of virtual CPUs that are available to the node type.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#nodeType",
"description": "[Output Only] The type of the resource. Always compute#nodeType for node types.",
"type": "string"
},
"localSsdGb": {
"description": "[Output Only] Local SSD available to the node type, defined in GB.",
"format": "int32",
"type": "integer"
},
"memoryMb": {
"description": "[Output Only] The amount of physical memory available to the node type, defined in MB.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "[Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"zone": {
"description": "[Output Only] The name of the zone where the node type resides, such as us-central1-a.",
"type": "string"
}
},
"type": "object"
},
"NodeTypeAggregatedList": {
"id": "NodeTypeAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NodeTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of node types."
},
"description": "A list of NodeTypesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#nodeTypeAggregatedList",
"description": "[Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeTypeList": {
"description": "Contains a list of node types.",
"id": "NodeTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NodeType resources.",
"items": {
"$ref": "NodeType"
},
"type": "array"
},
"kind": {
"default": "compute#nodeTypeList",
"description": "[Output Only] Type of resource.Always compute#nodeTypeList for lists of node types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"NodeTypesScopedList": {
"id": "NodeTypesScopedList",
"properties": {
"nodeTypes": {
"description": "[Output Only] A list of node types contained in this scope.",
"items": {
"$ref": "NodeType"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that appears when the node types list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Operation": {
"description": "Represents an Operation resource.\n\nGoogle Compute Engine has three Operation resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)\n\nYou can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.\n\nOperations can be global, regional or zonal. \n- For global operations, use the `globalOperations` resource. \n- For regional operations, use the `regionOperations` resource. \n- For zonal operations, use the `zonalOperations` resource. \n\nFor more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)",
"id": "Operation",
"properties": {
"clientOperationId": {
"description": "[Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.",
"type": "string"
},
"creationTimestamp": {
"description": "[Deprecated] This field is deprecated.",
"type": "string"
},
"description": {
"description": "[Output Only] A textual description of the operation, which is set when the operation is created.",
"type": "string"
},
"endTime": {
"description": "[Output Only] The time that this operation was completed. This value is in RFC3339 text format.",
"type": "string"
},
"error": {
"description": "[Output Only] If errors are generated during processing of the operation, this field will be populated.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this operation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error. This property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"httpErrorMessage": {
"description": "[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.",
"type": "string"
},
"httpErrorStatusCode": {
"description": "[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the operation. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"insertTime": {
"description": "[Output Only] The time that this operation was requested. This value is in RFC3339 text format.",
"type": "string"
},
"kind": {
"default": "compute#operation",
"description": "[Output Only] Type of the resource. Always `compute#operation` for Operation resources.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the operation.",
"type": "string"
},
"operationType": {
"description": "[Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.",
"type": "string"
},
"progress": {
"description": "[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.",
"format": "int32",
"type": "integer"
},
"region": {
"description": "[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"startTime": {
"description": "[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.",
"enum": [
"DONE",
"PENDING",
"RUNNING"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"statusMessage": {
"description": "[Output Only] An optional textual description of the current status of the operation.",
"type": "string"
},
"targetId": {
"description": "[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.",
"format": "uint64",
"type": "string"
},
"targetLink": {
"description": "[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.",
"type": "string"
},
"user": {
"description": "[Output Only] User who requested the operation, for example: `user@example.com`.",
"type": "string"
},
"warnings": {
"description": "[Output Only] If warning messages are generated during processing of the operation, this field will be populated.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"zone": {
"description": "[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.",
"type": "string"
}
},
"type": "object"
},
"OperationAggregatedList": {
"id": "OperationAggregatedList",
"properties": {
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "OperationsScopedList",
"description": "[Output Only] Name of the scope containing this set of operations."
},
"description": "[Output Only] A map of scoped operation lists.",
"type": "object"
},
"kind": {
"default": "compute#operationAggregatedList",
"description": "[Output Only] Type of resource. Always `compute#operationAggregatedList` for aggregated lists of operations.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"OperationList": {
"description": "Contains a list of Operation resources.",
"id": "OperationList",
"properties": {
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"items": {
"description": "[Output Only] A list of Operation resources.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"kind": {
"default": "compute#operationList",
"description": "[Output Only] Type of resource. Always `compute#operations` for Operations resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than `maxResults`, use the `nextPageToken` as a value for the query parameter `pageToken` in the next list request. Subsequent list requests will have their own `nextPageToken` to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"OperationsScopedList": {
"id": "OperationsScopedList",
"properties": {
"operations": {
"description": "[Output Only] A list of operations contained in this scope.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of operations when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"OutlierDetection": {
"description": "Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service.",
"id": "OutlierDetection",
"properties": {
"baseEjectionTime": {
"$ref": "Duration",
"description": "The base time that a host is ejected for. The real ejection time is equal to the base ejection time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s."
},
"consecutiveErrors": {
"description": "Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.",
"format": "int32",
"type": "integer"
},
"consecutiveGatewayFailure": {
"description": "The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 3.",
"format": "int32",
"type": "integer"
},
"enforcingConsecutiveErrors": {
"description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.",
"format": "int32",
"type": "integer"
},
"enforcingConsecutiveGatewayFailure": {
"description": "The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.",
"format": "int32",
"type": "integer"
},
"enforcingSuccessRate": {
"description": "The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.",
"format": "int32",
"type": "integer"
},
"interval": {
"$ref": "Duration",
"description": "Time interval between ejection analysis sweeps. This can result in both new ejections as well as hosts being returned to service. Defaults to 1 second."
},
"maxEjectionPercent": {
"description": "Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 50%.",
"format": "int32",
"type": "integer"
},
"successRateMinimumHosts": {
"description": "The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.",
"format": "int32",
"type": "integer"
},
"successRateRequestVolume": {
"description": "The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.",
"format": "int32",
"type": "integer"
},
"successRateStdevFactor": {
"description": "This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PacketMirroring": {
"description": "Represents a Packet Mirroring resource.\n\nPacket Mirroring clones the traffic of specified instances in your Virtual Private Cloud (VPC) network and forwards it to a collector destination, such as an instance group of an internal TCP/UDP load balancer, for analysis or examination. For more information about setting up Packet Mirroring, see Using Packet Mirroring. (== resource_for {$api_version}.packetMirrorings ==)",
"id": "PacketMirroring",
"properties": {
"collectorIlb": {
"$ref": "PacketMirroringForwardingRuleInfo",
"description": "The Forwarding Rule resource of type loadBalancingScheme=INTERNAL that will be used as collector for mirrored traffic. The specified forwarding rule must have isMirroringCollector set to true."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"enable": {
"description": "Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network.\n\nThe default is TRUE.",
"enum": [
"FALSE",
"TRUE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"filter": {
"$ref": "PacketMirroringFilter",
"description": "Filter for mirrored traffic. If unspecified, all traffic is mirrored."
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#packetMirroring",
"description": "[Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings.",
"type": "string"
},
"mirroredResources": {
"$ref": "PacketMirroringMirroredResourceInfo",
"description": "PacketMirroring mirroredResourceInfos. MirroredResourceInfo specifies a set of mirrored VM instances, subnetworks and/or tags for which traffic from/to all VM instances will be mirrored."
},
"name": {
"annotations": {
"required": [
"compute.packetMirrorings.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"$ref": "PacketMirroringNetworkInfo",
"annotations": {
"required": [
"compute.packetMirrorings.insert"
]
},
"description": "Specifies the mirrored VPC network. Only packets in this network will be mirrored. All mirrored VMs should have a NIC in the given network. All mirrored subnetworks should belong to the given network."
},
"priority": {
"description": "The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins.\n\nDefault value is 1000. Valid range is 0 through 65535.",
"format": "uint32",
"type": "integer"
},
"region": {
"description": "[Output Only] URI of the region where the packetMirroring resides.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringAggregatedList": {
"description": "Contains a list of packetMirrorings.",
"id": "PacketMirroringAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "PacketMirroringsScopedList",
"description": "Name of the scope containing this set of packetMirrorings."
},
"description": "A list of PacketMirroring resources.",
"type": "object"
},
"kind": {
"default": "compute#packetMirroringAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"PacketMirroringFilter": {
"id": "PacketMirroringFilter",
"properties": {
"IPProtocols": {
"description": "Protocols that apply as filter on mirrored traffic. If no protocols are specified, all traffic that matches the specified CIDR ranges is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.",
"items": {
"type": "string"
},
"type": "array"
},
"cidrRanges": {
"description": "IP CIDR ranges that apply as filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported. If no ranges are specified, all traffic that matches the specified IPProtocols is mirrored. If neither cidrRanges nor IPProtocols is specified, all traffic is mirrored.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PacketMirroringForwardingRuleInfo": {
"id": "PacketMirroringForwardingRuleInfo",
"properties": {
"canonicalUrl": {
"description": "[Output Only] Unique identifier for the forwarding rule; defined by the server.",
"type": "string"
},
"url": {
"description": "Resource URL to the forwarding rule representing the ILB configured as destination of the mirrored traffic.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringList": {
"description": "Contains a list of PacketMirroring resources.",
"id": "PacketMirroringList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of PacketMirroring resources.",
"items": {
"$ref": "PacketMirroring"
},
"type": "array"
},
"kind": {
"default": "compute#packetMirroringList",
"description": "[Output Only] Type of resource. Always compute#packetMirroring for packetMirrorings.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"PacketMirroringMirroredResourceInfo": {
"id": "PacketMirroringMirroredResourceInfo",
"properties": {
"instances": {
"description": "A set of virtual machine instances that are being mirrored. They must live in zones contained in the same region as this packetMirroring.\n\nNote that this config will apply only to those network interfaces of the Instances that belong to the network specified in this packetMirroring.\n\nYou may specify a maximum of 50 Instances.",
"items": {
"$ref": "PacketMirroringMirroredResourceInfoInstanceInfo"
},
"type": "array"
},
"subnetworks": {
"description": "A set of subnetworks for which traffic from/to all VM instances will be mirrored. They must live in the same region as this packetMirroring.\n\nYou may specify a maximum of 5 subnetworks.",
"items": {
"$ref": "PacketMirroringMirroredResourceInfoSubnetInfo"
},
"type": "array"
},
"tags": {
"description": "A set of mirrored tags. Traffic from/to all VM instances that have one or more of these tags will be mirrored.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PacketMirroringMirroredResourceInfoInstanceInfo": {
"id": "PacketMirroringMirroredResourceInfoInstanceInfo",
"properties": {
"canonicalUrl": {
"description": "[Output Only] Unique identifier for the instance; defined by the server.",
"type": "string"
},
"url": {
"description": "Resource URL to the virtual machine instance which is being mirrored.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringMirroredResourceInfoSubnetInfo": {
"id": "PacketMirroringMirroredResourceInfoSubnetInfo",
"properties": {
"canonicalUrl": {
"description": "[Output Only] Unique identifier for the subnetwork; defined by the server.",
"type": "string"
},
"url": {
"description": "Resource URL to the subnetwork for which traffic from/to all VM instances will be mirrored.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringNetworkInfo": {
"id": "PacketMirroringNetworkInfo",
"properties": {
"canonicalUrl": {
"description": "[Output Only] Unique identifier for the network; defined by the server.",
"type": "string"
},
"url": {
"description": "URL of the network resource.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringsScopedList": {
"id": "PacketMirroringsScopedList",
"properties": {
"packetMirrorings": {
"description": "A list of packetMirrorings contained in this scope.",
"items": {
"$ref": "PacketMirroring"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of packetMirrorings when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"PathMatcher": {
"description": "A matcher for the path portion of the URL. The BackendService from the longest-matched rule will serve the URL. If no rule was matched, the default service will be used.",
"id": "PathMatcher",
"properties": {
"defaultRouteAction": {
"$ref": "HttpRouteAction",
"description": "defaultRouteAction takes effect when none of the pathRules or routeRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.\nOnly one of defaultRouteAction or defaultUrlRedirect must be set."
},
"defaultService": {
"description": "The full or partial URL to the BackendService resource. This will be used if none of the pathRules or routeRules defined by this PathMatcher are matched. For example, the following are all valid URLs to a BackendService resource: \n- https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService \n- compute/v1/projects/project/global/backendServices/backendService \n- global/backendServices/backendService If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if defaultRouteAction specifies any weightedBackendServices, defaultService must not be specified.\nOnly one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.\nAuthorization requires one or more of the following Google IAM permissions on the specified resource default_service: \n- compute.backendBuckets.use \n- compute.backendServices.use",
"type": "string"
},
"defaultUrlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When none of the specified pathRules or routeRules match, the request is redirected to a URL specified by defaultUrlRedirect.\nIf defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set."
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect for the selected backendService.\nHeaderAction specified here are applied after the matching HttpRouteRule HeaderAction and before the HeaderAction in the UrlMap"
},
"name": {
"description": "The name to which this PathMatcher is referred by the HostRule.",
"type": "string"
},
"pathRules": {
"description": "The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that's required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis.\nFor example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list.\nWithin a given pathMatcher, only one of pathRules or routeRules must be set.",
"items": {
"$ref": "PathRule"
},
"type": "array"
},
"routeRules": {
"description": "The list of HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. routeRules are evaluated in order of priority, from the lowest to highest number.\nWithin a given pathMatcher, you can set only one of pathRules or routeRules.",
"items": {
"$ref": "HttpRouteRule"
},
"type": "array"
}
},
"type": "object"
},
"PathRule": {
"description": "A path-matching rule for a URL. If matched, will use the specified BackendService to handle the traffic arriving at this URL.",
"id": "PathRule",
"properties": {
"paths": {
"description": "The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.",
"items": {
"type": "string"
},
"type": "array"
},
"routeAction": {
"$ref": "HttpRouteAction",
"description": "In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices.\nOnly one of routeAction or urlRedirect must be set."
},
"service": {
"description": "The full or partial URL of the backend service resource to which traffic is directed if this rule is matched. If routeAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if service is specified, routeAction cannot contain any weightedBackendService s. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.\nOnly one of urlRedirect, service or routeAction.weightedBackendService must be set.",
"type": "string"
},
"urlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When a path pattern is matched, the request is redirected to a URL specified by urlRedirect.\nIf urlRedirect is specified, service or routeAction must not be set."
}
},
"type": "object"
},
"PerInstanceConfig": {
"id": "PerInstanceConfig",
"properties": {
"fingerprint": {
"description": "Fingerprint of this per-instance config. This field can be used in optimistic locking. It is ignored when inserting a per-instance config. An up-to-date fingerprint must be provided in order to update an existing per-instance config or the field needs to be unset.",
"format": "byte",
"type": "string"
},
"name": {
"description": "The name of a per-instance config and its corresponding instance. Serves as a merge key during UpdatePerInstanceConfigs operations, that is, if a per-instance config with the same name exists then it will be updated, otherwise a new one will be created for the VM instance with the same name. An attempt to create a per-instance config for a VM instance that either doesn't exist or is not part of the group will result in an error.",
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.\n\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n{ \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 }\n\n**YAML example:**\n\nbindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3\n\nFor a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.\n\n**Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"iamOwned": {
"description": "",
"type": "boolean"
},
"rules": {
"description": "If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.",
"items": {
"$ref": "Rule"
},
"type": "array"
},
"version": {
"description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.\n\nAny operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PreconfiguredWafSet": {
"id": "PreconfiguredWafSet",
"properties": {
"expressionSets": {
"description": "List of entities that are currently supported for WAF rules.",
"items": {
"$ref": "WafExpressionSet"
},
"type": "array"
}
},
"type": "object"
},
"Project": {
"description": "Represents a Project resource.\n\nA project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. (== resource_for {$api_version}.projects ==)",
"id": "Project",
"properties": {
"commonInstanceMetadata": {
"$ref": "Metadata",
"description": "Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultNetworkTier": {
"description": "This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"defaultServiceAccount": {
"description": "[Output Only] Default service account used by VMs running in this project.",
"type": "string"
},
"description": {
"description": "An optional textual description of the resource.",
"type": "string"
},
"enabledFeatures": {
"description": "Restricted features enabled for use on this project.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server. This is not the project ID, and is just a unique ID used by Compute Engine to identify resources.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#project",
"description": "[Output Only] Type of the resource. Always compute#project for projects.",
"type": "string"
},
"name": {
"description": "The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine.",
"type": "string"
},
"quotas": {
"description": "[Output Only] Quotas assigned to this project.",
"items": {
"$ref": "Quota"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"usageExportLocation": {
"$ref": "UsageExportLocation",
"description": "The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored."
},
"xpnProjectStatus": {
"description": "[Output Only] The role this project has in a shared VPC configuration. Currently only HOST projects are differentiated.",
"enum": [
"HOST",
"UNSPECIFIED_XPN_PROJECT_STATUS"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ProjectsDisableXpnResourceRequest": {
"id": "ProjectsDisableXpnResourceRequest",
"properties": {
"xpnResource": {
"$ref": "XpnResourceId",
"description": "Service resource (a.k.a service project) ID."
}
},
"type": "object"
},
"ProjectsEnableXpnResourceRequest": {
"id": "ProjectsEnableXpnResourceRequest",
"properties": {
"xpnResource": {
"$ref": "XpnResourceId",
"description": "Service resource (a.k.a service project) ID."
}
},
"type": "object"
},
"ProjectsGetXpnResources": {
"id": "ProjectsGetXpnResources",
"properties": {
"kind": {
"default": "compute#projectsGetXpnResources",
"description": "[Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects)",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"resources": {
"description": "Service resources (a.k.a service projects) attached to this project as their shared VPC host.",
"items": {
"$ref": "XpnResourceId"
},
"type": "array"
}
},
"type": "object"
},
"ProjectsListXpnHostsRequest": {
"id": "ProjectsListXpnHostsRequest",
"properties": {
"organization": {
"description": "Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project.",
"type": "string"
}
},
"type": "object"
},
"ProjectsSetDefaultNetworkTierRequest": {
"id": "ProjectsSetDefaultNetworkTierRequest",
"properties": {
"networkTier": {
"description": "Default network tier to be set.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Quota": {
"description": "A quotas entry.",
"id": "Quota",
"properties": {
"limit": {
"description": "[Output Only] Quota limit for this metric.",
"format": "double",
"type": "number"
},
"metric": {
"description": "[Output Only] Name of the quota metric.",
"enum": [
"AFFINITY_GROUPS",
"AUTOSCALERS",
"BACKEND_BUCKETS",
"BACKEND_SERVICES",
"C2_CPUS",
"COMMITMENTS",
"COMMITTED_C2_CPUS",
"COMMITTED_CPUS",
"COMMITTED_LICENSES",
"COMMITTED_LOCAL_SSD_TOTAL_GB",
"COMMITTED_N2D_CPUS",
"COMMITTED_N2_CPUS",
"COMMITTED_NVIDIA_K80_GPUS",
"COMMITTED_NVIDIA_P100_GPUS",
"COMMITTED_NVIDIA_P4_GPUS",
"COMMITTED_NVIDIA_T4_GPUS",
"COMMITTED_NVIDIA_V100_GPUS",
"CPUS",
"CPUS_ALL_REGIONS",
"DISKS_TOTAL_GB",
"EXTERNAL_VPN_GATEWAYS",
"FIREWALLS",
"FORWARDING_RULES",
"GLOBAL_INTERNAL_ADDRESSES",
"GPUS_ALL_REGIONS",
"HEALTH_CHECKS",
"IMAGES",
"INSTANCES",
"INSTANCE_GROUPS",
"INSTANCE_GROUP_MANAGERS",
"INSTANCE_TEMPLATES",
"INTERCONNECTS",
"INTERCONNECT_ATTACHMENTS_PER_REGION",
"INTERCONNECT_ATTACHMENTS_TOTAL_MBPS",
"INTERCONNECT_TOTAL_GBPS",
"INTERNAL_ADDRESSES",
"IN_PLACE_SNAPSHOTS",
"IN_USE_ADDRESSES",
"IN_USE_BACKUP_SCHEDULES",
"IN_USE_SNAPSHOT_SCHEDULES",
"LOCAL_SSD_TOTAL_GB",
"MACHINE_IMAGES",
"N2D_CPUS",
"N2_CPUS",
"NETWORKS",
"NETWORK_ENDPOINT_GROUPS",
"NODE_GROUPS",
"NODE_TEMPLATES",
"NVIDIA_K80_GPUS",
"NVIDIA_P100_GPUS",
"NVIDIA_P100_VWS_GPUS",
"NVIDIA_P4_GPUS",
"NVIDIA_P4_VWS_GPUS",
"NVIDIA_T4_GPUS",
"NVIDIA_T4_VWS_GPUS",
"NVIDIA_V100_GPUS",
"PACKET_MIRRORINGS",
"PREEMPTIBLE_CPUS",
"PREEMPTIBLE_LOCAL_SSD_GB",
"PREEMPTIBLE_NVIDIA_K80_GPUS",
"PREEMPTIBLE_NVIDIA_P100_GPUS",
"PREEMPTIBLE_NVIDIA_P100_VWS_GPUS",
"PREEMPTIBLE_NVIDIA_P4_GPUS",
"PREEMPTIBLE_NVIDIA_P4_VWS_GPUS",
"PREEMPTIBLE_NVIDIA_T4_GPUS",
"PREEMPTIBLE_NVIDIA_T4_VWS_GPUS",
"PREEMPTIBLE_NVIDIA_V100_GPUS",
"PUBLIC_ADVERTISED_PREFIXES",
"PUBLIC_DELEGATED_PREFIXES",
"REGIONAL_AUTOSCALERS",
"REGIONAL_INSTANCE_GROUP_MANAGERS",
"RESERVATIONS",
"RESOURCE_POLICIES",
"ROUTERS",
"ROUTES",
"SECURITY_POLICIES",
"SECURITY_POLICY_CEVAL_RULES",
"SECURITY_POLICY_RULES",
"SNAPSHOTS",
"SSD_TOTAL_GB",
"SSL_CERTIFICATES",
"STATIC_ADDRESSES",
"STATIC_BYOIP_ADDRESSES",
"SUBNETWORKS",
"TARGET_HTTPS_PROXIES",
"TARGET_HTTP_PROXIES",
"TARGET_INSTANCES",
"TARGET_POOLS",
"TARGET_SSL_PROXIES",
"TARGET_TCP_PROXIES",
"TARGET_VPN_GATEWAYS",
"URL_MAPS",
"VPN_GATEWAYS",
"VPN_TUNNELS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"owner": {
"description": "[Output Only] Owning resource. This is the resource on which this quota is applied.",
"type": "string"
},
"usage": {
"description": "[Output Only] Current usage of this metric.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Reference": {
"description": "Represents a reference to a resource.",
"id": "Reference",
"properties": {
"kind": {
"default": "compute#reference",
"description": "[Output Only] Type of the resource. Always compute#reference for references.",
"type": "string"
},
"referenceType": {
"description": "A description of the reference type with no implied semantics. Possible values include: \n- MEMBER_OF",
"type": "string"
},
"referrer": {
"description": "URL of the resource which refers to the target.",
"type": "string"
},
"target": {
"description": "URL of the resource to which this reference points.",
"type": "string"
}
},
"type": "object"
},
"Region": {
"description": "Represents a Region resource.\n\nA region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for {$api_version}.regions ==)",
"id": "Region",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this region."
},
"description": {
"description": "[Output Only] Textual description of the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#region",
"description": "[Output Only] Type of the resource. Always compute#region for regions.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the resource.",
"type": "string"
},
"quotas": {
"description": "[Output Only] Quotas assigned to this region.",
"items": {
"$ref": "Quota"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] Status of the region, either UP or DOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"zones": {
"description": "[Output Only] A list of zones available in this region, in the form of resource URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionAutoscalerList": {
"description": "Contains a list of autoscalers.",
"id": "RegionAutoscalerList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Autoscaler resources.",
"items": {
"$ref": "Autoscaler"
},
"type": "array"
},
"kind": {
"default": "compute#regionAutoscalerList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionDiskTypeList": {
"id": "RegionDiskTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of DiskType resources.",
"items": {
"$ref": "DiskType"
},
"type": "array"
},
"kind": {
"default": "compute#regionDiskTypeList",
"description": "[Output Only] Type of resource. Always compute#regionDiskTypeList for region disk types.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionDisksAddResourcePoliciesRequest": {
"id": "RegionDisksAddResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be added to this disk.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionDisksRemoveResourcePoliciesRequest": {
"id": "RegionDisksRemoveResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be removed from this disk.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionDisksResizeRequest": {
"id": "RegionDisksResizeRequest",
"properties": {
"sizeGb": {
"description": "The new size of the regional persistent disk, which is specified in GB.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupList": {
"description": "Contains a list of InstanceGroup resources.",
"id": "RegionInstanceGroupList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceGroup resources.",
"items": {
"$ref": "InstanceGroup"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupList",
"description": "The resource type.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagerList": {
"description": "Contains a list of managed instance groups.",
"id": "RegionInstanceGroupManagerList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceGroupManager resources.",
"items": {
"$ref": "InstanceGroupManager"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupManagerList",
"description": "[Output Only] The resource type, which is always compute#instanceGroupManagerList for a list of managed instance groups that exist in th regional scope.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagersAbandonInstancesRequest": {
"id": "RegionInstanceGroupManagersAbandonInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to abandon. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersApplyUpdatesRequest": {
"description": "InstanceGroupManagers.applyUpdatesToInstances",
"id": "RegionInstanceGroupManagersApplyUpdatesRequest",
"properties": {
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply updates. Each URL can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
},
"minimalAction": {
"description": "The minimal action that you want to perform on each instance during the update: \n- REPLACE: At minimum, delete the instance and create it again. \n- RESTART: Stop the instance and start it again. \n- REFRESH: Do not stop the instance. \n- NONE: Do not disrupt the instance at all. By default, the minimum action is NONE. If your update requires a more disruptive action than you set with this flag, the necessary action is performed to execute the update.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "The most disruptive action that you want to perform on each instance during the update: \n- REPLACE: Delete the instance and create it again. \n- RESTART: Stop the instance and start it again. \n- REFRESH: Do not stop the instance. \n- NONE: Do not disrupt the instance at all. By default, the most disruptive allowed action is REPLACE. If your update requires a more disruptive action than you set with this flag, the update request will fail.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupManagersCreateInstancesRequest": {
"description": "RegionInstanceGroupManagers.createInstances",
"id": "RegionInstanceGroupManagersCreateInstancesRequest",
"properties": {
"instances": {
"description": "[Required] List of specifications of per-instance configs.",
"items": {
"$ref": "PerInstanceConfig"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersDeleteInstancesRequest": {
"id": "RegionInstanceGroupManagersDeleteInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersListErrorsResponse": {
"id": "RegionInstanceGroupManagersListErrorsResponse",
"properties": {
"items": {
"description": "[Output Only] The list of errors of the managed instance group.",
"items": {
"$ref": "InstanceManagedByIgmError"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupManagersListInstancesResponse": {
"id": "RegionInstanceGroupManagersListInstancesResponse",
"properties": {
"managedInstances": {
"description": "A list of managed instances.",
"items": {
"$ref": "ManagedInstance"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupManagersRecreateRequest": {
"id": "RegionInstanceGroupManagersRecreateRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to recreate. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersSetTargetPoolsRequest": {
"id": "RegionInstanceGroupManagersSetTargetPoolsRequest",
"properties": {
"fingerprint": {
"description": "Fingerprint of the target pools information, which is a hash of the contents. This field is used for optimistic locking when you update the target pool entries. This field is optional.",
"format": "byte",
"type": "string"
},
"targetPools": {
"description": "The URL of all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersSetTemplateRequest": {
"id": "RegionInstanceGroupManagersSetTemplateRequest",
"properties": {
"instanceTemplate": {
"description": "URL of the InstanceTemplate resource from which all new instances will be created.",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupsListInstances": {
"id": "RegionInstanceGroupsListInstances",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstanceWithNamedPorts resources.",
"items": {
"$ref": "InstanceWithNamedPorts"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupsListInstances",
"description": "The resource type.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupsListInstancesRequest": {
"id": "RegionInstanceGroupsListInstancesRequest",
"properties": {
"instanceState": {
"description": "Instances in which state should be returned. Valid options are: 'ALL', 'RUNNING'. By default, it lists all instances.",
"enum": [
"ALL",
"RUNNING"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"portName": {
"description": "Name of port user is interested in. It is optional. If it is set, only information about this ports will be returned. If it is not set, all the named ports will be returned. Always lists all instances.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupsSetNamedPortsRequest": {
"id": "RegionInstanceGroupsSetNamedPortsRequest",
"properties": {
"fingerprint": {
"description": "The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request.",
"format": "byte",
"type": "string"
},
"namedPorts": {
"description": "The list of named ports to set for this instance group.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
}
},
"type": "object"
},
"RegionList": {
"description": "Contains a list of region resources.",
"id": "RegionList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Region resources.",
"items": {
"$ref": "Region"
},
"type": "array"
},
"kind": {
"default": "compute#regionList",
"description": "[Output Only] Type of resource. Always compute#regionList for lists of regions.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RegionSetLabelsRequest": {
"id": "RegionSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels to set for this resource.",
"type": "object"
}
},
"type": "object"
},
"RegionSetPolicyRequest": {
"id": "RegionSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte",
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"RegionTargetHttpsProxiesSetSslCertificatesRequest": {
"id": "RegionTargetHttpsProxiesSetSslCertificatesRequest",
"properties": {
"sslCertificates": {
"description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionUrlMapsValidateRequest": {
"id": "RegionUrlMapsValidateRequest",
"properties": {
"resource": {
"$ref": "UrlMap",
"description": "Content of the UrlMap to be validated."
}
},
"type": "object"
},
"RequestMirrorPolicy": {
"description": "A policy that specifies how requests intended for the route's backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow.",
"id": "RequestMirrorPolicy",
"properties": {
"backendService": {
"description": "The full or partial URL to the BackendService resource being mirrored to.",
"type": "string"
}
},
"type": "object"
},
"Reservation": {
"description": "Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)",
"id": "Reservation",
"properties": {
"commitment": {
"description": "[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#reservation",
"description": "[Output Only] Type of the resource. Always compute#reservations for reservations.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"specificReservation": {
"$ref": "AllocationSpecificSKUReservation",
"description": "Reservation for instances with specific machine shapes."
},
"specificReservationRequired": {
"description": "Indicates whether the reservation can be consumed by VMs with affinity for \"any\" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.",
"type": "boolean"
},
"status": {
"description": "[Output Only] The status of the reservation.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY",
"UPDATING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"zone": {
"description": "Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.",
"type": "string"
}
},
"type": "object"
},
"ReservationAffinity": {
"description": "Specifies the reservations that this instance can consume from.",
"id": "ReservationAffinity",
"properties": {
"consumeReservationType": {
"description": "Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples.",
"enum": [
"ANY_RESERVATION",
"NO_RESERVATION",
"SPECIFIC_RESERVATION",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"key": {
"description": "Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value.",
"type": "string"
},
"values": {
"description": "Corresponds to the label values of a reservation resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ReservationAggregatedList": {
"description": "Contains a list of reservations.",
"id": "ReservationAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "ReservationsScopedList",
"description": "Name of the scope containing this set of reservations."
},
"description": "A list of Allocation resources.",
"type": "object"
},
"kind": {
"default": "compute#reservationAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ReservationList": {
"id": "ReservationList",
"properties": {
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"items": {
"description": "[Output Only] A list of Allocation resources.",
"items": {
"$ref": "Reservation"
},
"type": "array"
},
"kind": {
"default": "compute#reservationList",
"description": "[Output Only] Type of resource.Always compute#reservationsList for listsof reservations",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ReservationsResizeRequest": {
"id": "ReservationsResizeRequest",
"properties": {
"specificSkuCount": {
"description": "Number of allocated resources can be resized with minimum = 1 and maximum = 1000.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ReservationsScopedList": {
"id": "ReservationsScopedList",
"properties": {
"reservations": {
"description": "A list of reservations contained in this scope.",
"items": {
"$ref": "Reservation"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of reservations when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ResourceCommitment": {
"description": "Commitment for a particular resource (a Commitment is composed of one or more of these).",
"id": "ResourceCommitment",
"properties": {
"acceleratorType": {
"description": "Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.",
"type": "string"
},
"amount": {
"description": "The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.",
"format": "int64",
"type": "string"
},
"type": {
"description": "Type of resource for which this commitment applies. Possible values are VCPU and MEMORY",
"enum": [
"ACCELERATOR",
"LOCAL_SSD",
"MEMORY",
"UNSPECIFIED",
"VCPU"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ResourceGroupReference": {
"id": "ResourceGroupReference",
"properties": {
"group": {
"description": "A URI referencing one of the instance groups or network endpoint groups listed in the backend service.",
"type": "string"
}
},
"type": "object"
},
"ResourcePoliciesScopedList": {
"id": "ResourcePoliciesScopedList",
"properties": {
"resourcePolicies": {
"description": "A list of resourcePolicies contained in this scope.",
"items": {
"$ref": "ResourcePolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of resourcePolicies when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ResourcePolicy": {
"description": "Represents a Resource Policy resource. You can use resource policies to schedule actions for some Compute Engine resources. For example, you can use them to schedule persistent disk snapshots.\n\n(== resource_for {$api_version}.resourcePolicies ==)",
"id": "ResourcePolicy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"type": "string"
},
"groupPlacementPolicy": {
"$ref": "ResourcePolicyGroupPlacementPolicy",
"description": "Resource policy for instacnes for placement configuration."
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#resourcePolicy",
"description": "[Output Only] Type of the resource. Always compute#resource_policies for resource policies.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"snapshotSchedulePolicy": {
"$ref": "ResourcePolicySnapshotSchedulePolicy",
"description": "Resource policy for persistent disks for creating snapshots."
},
"status": {
"description": "[Output Only] The status of resource policy creation.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyAggregatedList": {
"description": "Contains a list of resourcePolicies.",
"id": "ResourcePolicyAggregatedList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "ResourcePoliciesScopedList",
"description": "Name of the scope containing this set of resourcePolicies."
},
"description": "A list of ResourcePolicy resources.",
"type": "object"
},
"kind": {
"default": "compute#resourcePolicyAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ResourcePolicyDailyCycle": {
"description": "Time window specified for daily operations.",
"id": "ResourcePolicyDailyCycle",
"properties": {
"daysInCycle": {
"description": "Defines a schedule with units measured in months. The value determines how many months pass between the start of each cycle.",
"format": "int32",
"type": "integer"
},
"duration": {
"description": "[Output only] A predetermined duration for the window, automatically chosen to be the smallest possible in the given scenario.",
"type": "string"
},
"startTime": {
"description": "Start time of the window. This must be in UTC format that resolves to one of 00:00, 04:00, 08:00, 12:00, 16:00, or 20:00. For example, both 13:00-5 and 08:00 are valid.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyGroupPlacementPolicy": {
"description": "A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality",
"id": "ResourcePolicyGroupPlacementPolicy",
"properties": {
"availabilityDomainCount": {
"description": "The number of availability domains instances will be spread across. If two instances are in different availability domain, they will not be put in the same low latency network",
"format": "int32",
"type": "integer"
},
"collocation": {
"description": "Specifies network collocation",
"enum": [
"COLLOCATED",
"UNSPECIFIED_COLLOCATION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"vmCount": {
"description": "Number of vms in this placement group",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ResourcePolicyHourlyCycle": {
"description": "Time window specified for hourly operations.",
"id": "ResourcePolicyHourlyCycle",
"properties": {
"duration": {
"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
"type": "string"
},
"hoursInCycle": {
"description": "Defines a schedule with units measured in hours. The value determines how many hours pass between the start of each cycle.",
"format": "int32",
"type": "integer"
},
"startTime": {
"description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyList": {
"id": "ResourcePolicyList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"items": {
"description": "[Output Only] A list of ResourcePolicy resources.",
"items": {
"$ref": "ResourcePolicy"
},
"type": "array"
},
"kind": {
"default": "compute#resourcePolicyList",
"description": "[Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ResourcePolicySnapshotSchedulePolicy": {
"description": "A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained.",
"id": "ResourcePolicySnapshotSchedulePolicy",
"properties": {
"retentionPolicy": {
"$ref": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy",
"description": "Retention policy applied to snapshots created by this resource policy."
},
"schedule": {
"$ref": "ResourcePolicySnapshotSchedulePolicySchedule",
"description": "A Vm Maintenance Policy specifies what kind of infrastructure maintenance we are allowed to perform on this VM and when. Schedule that is applied to disks covered by this policy."
},
"snapshotProperties": {
"$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
"description": "Properties with which snapshots are created such as labels, encryption keys."
}
},
"type": "object"
},
"ResourcePolicySnapshotSchedulePolicyRetentionPolicy": {
"description": "Policy for retention of scheduled snapshots.",
"id": "ResourcePolicySnapshotSchedulePolicyRetentionPolicy",
"properties": {
"maxRetentionDays": {
"description": "Maximum age of the snapshot that is allowed to be kept.",
"format": "int32",
"type": "integer"
},
"onSourceDiskDelete": {
"description": "Specifies the behavior to apply to scheduled snapshots when the source disk is deleted.",
"enum": [
"APPLY_RETENTION_POLICY",
"KEEP_AUTO_SNAPSHOTS",
"UNSPECIFIED_ON_SOURCE_DISK_DELETE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ResourcePolicySnapshotSchedulePolicySchedule": {
"description": "A schedule for disks where the schedueled operations are performed.",
"id": "ResourcePolicySnapshotSchedulePolicySchedule",
"properties": {
"dailySchedule": {
"$ref": "ResourcePolicyDailyCycle"
},
"hourlySchedule": {
"$ref": "ResourcePolicyHourlyCycle"
},
"weeklySchedule": {
"$ref": "ResourcePolicyWeeklyCycle"
}
},
"type": "object"
},
"ResourcePolicySnapshotSchedulePolicySnapshotProperties": {
"description": "Specified snapshot properties for scheduled snapshots created by this policy.",
"id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
"properties": {
"guestFlush": {
"description": "Indication to perform a 'guest aware' snapshot.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to scheduled snapshots. These can be later modified by the setLabels method. Label values may be empty.",
"type": "object"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the auto snapshot (regional or multi-regional).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ResourcePolicyWeeklyCycle": {
"description": "Time window specified for weekly operations.",
"id": "ResourcePolicyWeeklyCycle",
"properties": {
"dayOfWeeks": {
"description": "Up to 7 intervals/windows, one for each day of the week.",
"items": {
"$ref": "ResourcePolicyWeeklyCycleDayOfWeek"
},
"type": "array"
}
},
"type": "object"
},
"ResourcePolicyWeeklyCycleDayOfWeek": {
"id": "ResourcePolicyWeeklyCycleDayOfWeek",
"properties": {
"day": {
"description": "Defines a schedule that runs on specific days of the week. Specify one or more days. The following options are available: MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.",
"enum": [
"FRIDAY",
"INVALID",
"MONDAY",
"SATURDAY",
"SUNDAY",
"THURSDAY",
"TUESDAY",
"WEDNESDAY"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"duration": {
"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.",
"type": "string"
},
"startTime": {
"description": "Time within the window to start the operations. It must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
"type": "string"
}
},
"type": "object"
},
"Route": {
"description": "Represents a Route resource.\n\nA route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview. (== resource_for {$api_version}.routes ==)",
"id": "Route",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you create the resource.",
"type": "string"
},
"destRange": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "The destination range of outgoing packets that this route applies to. Only IPv4 is supported.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#route",
"description": "[Output Only] Type of this resource. Always compute#routes for Route resources.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "Fully-qualified URL of the network that this route applies to.",
"type": "string"
},
"nextHopGateway": {
"description": "The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/project/global/gateways/default-internet-gateway",
"type": "string"
},
"nextHopIlb": {
"description": "The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets. You can only specify the forwarding rule as a partial or full URL. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule \n- regions/region/forwardingRules/forwardingRule",
"type": "string"
},
"nextHopInstance": {
"description": "The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example:\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/",
"type": "string"
},
"nextHopIp": {
"description": "The network IP address of an instance that should handle matching packets. Only IPv4 is supported.",
"type": "string"
},
"nextHopNetwork": {
"description": "The URL of the local network if it should handle matching packets.",
"type": "string"
},
"nextHopPeering": {
"description": "[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.",
"type": "string"
},
"nextHopVpnTunnel": {
"description": "The URL to a VpnTunnel that should handle matching packets.",
"type": "string"
},
"priority": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive.",
"format": "uint32",
"type": "integer"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"tags": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "A list of instance tags to which this route applies.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"RouteList": {
"description": "Contains a list of Route resources.",
"id": "RouteList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Route resources.",
"items": {
"$ref": "Route"
},
"type": "array"
},
"kind": {
"default": "compute#routeList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Router": {
"description": "Represents a Cloud Router resource.\n\nFor more information about Cloud Router, read the the Cloud Router overview.",
"id": "Router",
"properties": {
"bgp": {
"$ref": "RouterBgp",
"description": "BGP information specific to this router."
},
"bgpPeers": {
"description": "BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273.",
"items": {
"$ref": "RouterBgpPeer"
},
"type": "array"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"interfaces": {
"description": "Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both.",
"items": {
"$ref": "RouterInterface"
},
"type": "array"
},
"kind": {
"default": "compute#router",
"description": "[Output Only] Type of resource. Always compute#router for routers.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"nats": {
"description": "A list of NAT services created in this router.",
"items": {
"$ref": "RouterNat"
},
"type": "array"
},
"network": {
"annotations": {
"required": [
"compute.routers.insert",
"compute.routers.update"
]
},
"description": "URI of the network to which this router belongs.",
"type": "string"
},
"region": {
"description": "[Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
}
},
"type": "object"
},
"RouterAdvertisedIpRange": {
"description": "Description-tagged IP ranges for the router to advertise.",
"id": "RouterAdvertisedIpRange",
"properties": {
"description": {
"description": "User-specified description for the IP range.",
"type": "string"
},
"range": {
"description": "The IP range to advertise. The value must be a CIDR-formatted string.",
"type": "string"
}
},
"type": "object"
},
"RouterAggregatedList": {
"description": "Contains a list of routers.",
"id": "RouterAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "RoutersScopedList",
"description": "Name of the scope containing this set of routers."
},
"description": "A list of Router resources.",
"type": "object"
},
"kind": {
"default": "compute#routerAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RouterBgp": {
"id": "RouterBgp",
"properties": {
"advertiseMode": {
"description": "User-specified flag to indicate which mode to use for advertisement. The options are DEFAULT or CUSTOM.",
"enum": [
"CUSTOM",
"DEFAULT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"advertisedGroups": {
"description": "User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.",
"items": {
"enum": [
"ALL_SUBNETS"
],
"enumDescriptions": [
""
],
"type": "string"
},
"type": "array"
},
"advertisedIpRanges": {
"description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and is advertised to all peers of the router. These IP ranges will be advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.",
"items": {
"$ref": "RouterAdvertisedIpRange"
},
"type": "array"
},
"asn": {
"description": "Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"RouterBgpPeer": {
"id": "RouterBgpPeer",
"properties": {
"advertiseMode": {
"description": "User-specified flag to indicate which mode to use for advertisement.",
"enum": [
"CUSTOM",
"DEFAULT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"advertisedGroups": {
"description": "User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: \n- ALL_SUBNETS: Advertises all available subnets, including peer VPC subnets. \n- ALL_VPC_SUBNETS: Advertises the router's own VPC subnets. \n- ALL_PEER_VPC_SUBNETS: Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.",
"items": {
"enum": [
"ALL_SUBNETS"
],
"enumDescriptions": [
""
],
"type": "string"
},
"type": "array"
},
"advertisedIpRanges": {
"description": "User-specified list of individual IP ranges to advertise in custom mode. This field can only be populated if advertise_mode is CUSTOM and overrides the list defined for the router (in the \"bgp\" message). These IP ranges are advertised in addition to any specified groups. Leave this field blank to advertise no custom IP ranges.",
"items": {
"$ref": "RouterAdvertisedIpRange"
},
"type": "array"
},
"advertisedRoutePriority": {
"description": "The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.",
"format": "uint32",
"type": "integer"
},
"interfaceName": {
"description": "Name of the interface the BGP peer is associated with.",
"type": "string"
},
"ipAddress": {
"description": "IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.",
"type": "string"
},
"managementType": {
"description": "[Output Only] The resource that configures and manages this BGP peer. \n- MANAGED_BY_USER is the default value and can be managed by you or other users \n- MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.",
"enum": [
"MANAGED_BY_ATTACHMENT",
"MANAGED_BY_USER"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"peerAsn": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.",
"format": "uint32",
"type": "integer"
},
"peerIpAddress": {
"description": "IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.",
"type": "string"
}
},
"type": "object"
},
"RouterInterface": {
"id": "RouterInterface",
"properties": {
"ipRange": {
"description": "IP address and range of the interface. The IP range must be in the RFC3927 link-local IP address space. The value must be a CIDR-formatted string, for example: 169.254.0.1/30. NOTE: Do not truncate the address as it represents the IP address of the interface.",
"type": "string"
},
"linkedInterconnectAttachment": {
"description": "URI of the linked Interconnect attachment. It must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.",
"type": "string"
},
"linkedVpnTunnel": {
"description": "URI of the linked VPN tunnel, which must be in the same region as the router. Each interface can have one linked resource, which can be a VPN tunnel, an Interconnect attachment, or a virtual machine instance.",
"type": "string"
},
"managementType": {
"description": "[Output Only] The resource that configures and manages this interface. \n- MANAGED_BY_USER is the default value and can be managed directly by users. \n- MANAGED_BY_ATTACHMENT is an interface that is configured and managed by Cloud Interconnect, specifically, by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of interface when the PARTNER InterconnectAttachment is created, updated, or deleted.",
"enum": [
"MANAGED_BY_ATTACHMENT",
"MANAGED_BY_USER"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of this interface entry. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
}
},
"type": "object"
},
"RouterList": {
"description": "Contains a list of Router resources.",
"id": "RouterList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Router resources.",
"items": {
"$ref": "Router"
},
"type": "array"
},
"kind": {
"default": "compute#routerList",
"description": "[Output Only] Type of resource. Always compute#router for routers.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"RouterNat": {
"description": "Represents a Nat resource. It enables the VMs within the specified subnetworks to access Internet without external IP addresses. It specifies a list of subnetworks (and the ranges within) that want to use NAT. Customers can also provide the external IPs that would be used for NAT. GCP would auto-allocate ephemeral IPs if no external IPs are provided.",
"id": "RouterNat",
"properties": {
"drainNatIps": {
"description": "A list of URLs of the IP resources to be drained. These IPs must be valid static external IPs that have been assigned to the NAT. These IPs should be used for updating/patching a NAT only.",
"items": {
"type": "string"
},
"type": "array"
},
"icmpIdleTimeoutSec": {
"description": "Timeout (in seconds) for ICMP connections. Defaults to 30s if not set.",
"format": "int32",
"type": "integer"
},
"logConfig": {
"$ref": "RouterNatLogConfig",
"description": "Configure logging on this NAT."
},
"minPortsPerVm": {
"description": "Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. This is rounded up to the nearest power of 2. For example, if the value of this field is 50, at least 64 ports are allocated to a VM.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Unique name of this Nat service. The name must be 1-63 characters long and comply with RFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"natIpAllocateOption": {
"description": "Specify the NatIpAllocateOption, which can take one of the following values: \n- MANUAL_ONLY: Uses only Nat IP addresses provided by customers. When there are not enough specified Nat IPs, the Nat service fails for new VMs. \n- AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should be empty.",
"enum": [
"AUTO_ONLY",
"MANUAL_ONLY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"natIps": {
"description": "A list of URLs of the IP resources used for this Nat service. These IP addresses must be valid static external IP addresses assigned to the project.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceSubnetworkIpRangesToNat": {
"description": "Specify the Nat option, which can take one of the following values: \n- ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every Subnetwork are allowed to Nat. \n- ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges in every Subnetwork are allowed to Nat. \n- LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat (specified in the field subnetwork below) The default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED. Note that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES or ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, then there should not be any other Router.Nat section in any Router for this network in this region.",
"enum": [
"ALL_SUBNETWORKS_ALL_IP_RANGES",
"ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES",
"LIST_OF_SUBNETWORKS"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"subnetworks": {
"description": "A list of Subnetwork resources whose traffic should be translated by NAT Gateway. It is used only when LIST_OF_SUBNETWORKS is selected for the SubnetworkIpRangeToNatOption above.",
"items": {
"$ref": "RouterNatSubnetworkToNat"
},
"type": "array"
},
"tcpEstablishedIdleTimeoutSec": {
"description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set.",
"format": "int32",
"type": "integer"
},
"tcpTransitoryIdleTimeoutSec": {
"description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set.",
"format": "int32",
"type": "integer"
},
"udpIdleTimeoutSec": {
"description": "Timeout (in seconds) for UDP connections. Defaults to 30s if not set.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RouterNatLogConfig": {
"description": "Configuration of logging on a NAT.",
"id": "RouterNatLogConfig",
"properties": {
"enable": {
"description": "Indicates whether or not to export logs. This is false by default.",
"type": "boolean"
},
"filter": {
"description": "Specify the desired filtering of logs on this NAT. If unspecified, logs are exported for all connections handled by this NAT. This option can take one of the following values: \n- ERRORS_ONLY: Export logs only for connection failures. \n- TRANSLATIONS_ONLY: Export logs only for successful connections. \n- ALL: Export logs for all connections, successful and unsuccessful.",
"enum": [
"ALL",
"ERRORS_ONLY",
"TRANSLATIONS_ONLY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"RouterNatSubnetworkToNat": {
"description": "Defines the IP ranges that want to use NAT for a subnetwork.",
"id": "RouterNatSubnetworkToNat",
"properties": {
"name": {
"description": "URL for the subnetwork resource that will use NAT.",
"type": "string"
},
"secondaryIpRangeNames": {
"description": "A list of the secondary ranges of the Subnetwork that are allowed to use NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\" is one of the values in source_ip_ranges_to_nat.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceIpRangesToNat": {
"description": "Specify the options for NAT ranges in the Subnetwork. All options of a single value are valid except NAT_IP_RANGE_OPTION_UNSPECIFIED. The only valid option with multiple values is: [\"PRIMARY_IP_RANGE\", \"LIST_OF_SECONDARY_IP_RANGES\"] Default: [ALL_IP_RANGES]",
"items": {
"enum": [
"ALL_IP_RANGES",
"LIST_OF_SECONDARY_IP_RANGES",
"PRIMARY_IP_RANGE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RouterStatus": {
"id": "RouterStatus",
"properties": {
"bestRoutes": {
"description": "Best routes for this router's network.",
"items": {
"$ref": "Route"
},
"type": "array"
},
"bestRoutesForRouter": {
"description": "Best routes learned by this router.",
"items": {
"$ref": "Route"
},
"type": "array"
},
"bgpPeerStatus": {
"items": {
"$ref": "RouterStatusBgpPeerStatus"
},
"type": "array"
},
"natStatus": {
"items": {
"$ref": "RouterStatusNatStatus"
},
"type": "array"
},
"network": {
"description": "URI of the network to which this router belongs.",
"type": "string"
}
},
"type": "object"
},
"RouterStatusBgpPeerStatus": {
"id": "RouterStatusBgpPeerStatus",
"properties": {
"advertisedRoutes": {
"description": "Routes that were advertised to the remote BGP peer",
"items": {
"$ref": "Route"
},
"type": "array"
},
"ipAddress": {
"description": "IP address of the local BGP interface.",
"type": "string"
},
"linkedVpnTunnel": {
"description": "URL of the VPN tunnel that this BGP peer controls.",
"type": "string"
},
"name": {
"description": "Name of this BGP peer. Unique within the Routers resource.",
"type": "string"
},
"numLearnedRoutes": {
"description": "Number of routes learned from the remote BGP Peer.",
"format": "uint32",
"type": "integer"
},
"peerIpAddress": {
"description": "IP address of the remote BGP interface.",
"type": "string"
},
"state": {
"description": "BGP state as specified in RFC1771.",
"type": "string"
},
"status": {
"description": "Status of the BGP peer: {UP, DOWN}",
"enum": [
"DOWN",
"UNKNOWN",
"UP"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"uptime": {
"description": "Time this session has been up. Format: 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds",
"type": "string"
},
"uptimeSeconds": {
"description": "Time this session has been up, in seconds. Format: 145",
"type": "string"
}
},
"type": "object"
},
"RouterStatusNatStatus": {
"description": "Status of a NAT contained in this router. Next tag: 9",
"id": "RouterStatusNatStatus",
"properties": {
"autoAllocatedNatIps": {
"description": "A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]",
"items": {
"type": "string"
},
"type": "array"
},
"drainAutoAllocatedNatIps": {
"description": "A list of IPs auto-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"type": "array"
},
"drainUserAllocatedNatIps": {
"description": "A list of IPs user-allocated for NAT that are in drain mode. Example: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"type": "array"
},
"minExtraNatIpsNeeded": {
"description": "The number of extra IPs to allocate. This will be greater than 0 only if user-specified IPs are NOT enough to allow all configured VMs to use NAT. This value is meaningful only when auto-allocation of NAT IPs is *not* used.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Unique name of this NAT.",
"type": "string"
},
"numVmEndpointsWithNatMappings": {
"description": "Number of VM endpoints (i.e., Nics) that can use NAT.",
"format": "int32",
"type": "integer"
},
"userAllocatedNatIpResources": {
"description": "A list of fully qualified URLs of reserved IP address resources.",
"items": {
"type": "string"
},
"type": "array"
},
"userAllocatedNatIps": {
"description": "A list of IPs user-allocated for NAT. They will be raw IP strings like \"179.12.26.133\".",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RouterStatusResponse": {
"id": "RouterStatusResponse",
"properties": {
"kind": {
"default": "compute#routerStatusResponse",
"description": "Type of resource.",
"type": "string"
},
"result": {
"$ref": "RouterStatus"
}
},
"type": "object"
},
"RoutersPreviewResponse": {
"id": "RoutersPreviewResponse",
"properties": {
"resource": {
"$ref": "Router",
"description": "Preview of given router."
}
},
"type": "object"
},
"RoutersScopedList": {
"id": "RoutersScopedList",
"properties": {
"routers": {
"description": "A list of routers contained in this scope.",
"items": {
"$ref": "Router"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of routers when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"Rule": {
"description": "A rule to be applied in a Policy.",
"id": "Rule",
"properties": {
"action": {
"description": "Required",
"enum": [
"ALLOW",
"ALLOW_WITH_LOG",
"DENY",
"DENY_WITH_LOG",
"LOG",
"NO_ACTION"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"conditions": {
"description": "Additional restrictions that must be met. All conditions must pass for the rule to match.",
"items": {
"$ref": "Condition"
},
"type": "array"
},
"description": {
"description": "Human-readable description of the rule.",
"type": "string"
},
"ins": {
"description": "If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.",
"items": {
"type": "string"
},
"type": "array"
},
"logConfigs": {
"description": "The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.",
"items": {
"$ref": "LogConfig"
},
"type": "array"
},
"notIns": {
"description": "If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.",
"items": {
"type": "string"
},
"type": "array"
},
"permissions": {
"description": "A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SSLHealthCheck": {
"id": "SSLHealthCheck",
"properties": {
"port": {
"description": "The TCP port number for the health check request. The default value is 443. Valid values are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in port is used for health checking.\nUSE_NAMED_PORT: The portName is used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, SSL health check follows behavior specified in port and portName fields.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"request": {
"description": "The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
"type": "string"
},
"response": {
"description": "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
"type": "string"
}
},
"type": "object"
},
"Scheduling": {
"description": "Sets the scheduling options for an Instance. NextID: 11",
"id": "Scheduling",
"properties": {
"automaticRestart": {
"description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.\n\nBy default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.",
"type": "boolean"
},
"nodeAffinities": {
"description": "A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.",
"items": {
"$ref": "SchedulingNodeAffinity"
},
"type": "array"
},
"onHostMaintenance": {
"description": "Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.",
"enum": [
"MIGRATE",
"TERMINATE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"preemptible": {
"description": "Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created.",
"type": "boolean"
}
},
"type": "object"
},
"SchedulingNodeAffinity": {
"description": "Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled.",
"id": "SchedulingNodeAffinity",
"properties": {
"key": {
"description": "Corresponds to the label key of Node resource.",
"type": "string"
},
"operator": {
"description": "Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.",
"enum": [
"IN",
"NOT_IN",
"OPERATOR_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"values": {
"description": "Corresponds to the label values of Node resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPoliciesListPreconfiguredExpressionSetsResponse": {
"id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse",
"properties": {
"preconfiguredExpressionSets": {
"$ref": "SecurityPoliciesWafConfig"
}
},
"type": "object"
},
"SecurityPoliciesWafConfig": {
"id": "SecurityPoliciesWafConfig",
"properties": {
"wafRules": {
"$ref": "PreconfiguredWafSet"
}
},
"type": "object"
},
"SecurityPolicy": {
"description": "Represents a Cloud Armor Security Policy resource.\n\nOnly external backend services that use load balancers can reference a Security Policy. For more information, read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.securityPolicies ==)",
"id": "SecurityPolicy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"fingerprint": {
"description": "Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make get() request to the security policy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#securityPolicy",
"description": "[Output only] Type of the resource. Always compute#securityPolicyfor security policies",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"rules": {
"description": "A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match \"*\"). If no rules are provided when creating a security policy, a default rule with action \"allow\" will be added.",
"items": {
"$ref": "SecurityPolicyRule"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyList": {
"id": "SecurityPolicyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of SecurityPolicy resources.",
"items": {
"$ref": "SecurityPolicy"
},
"type": "array"
},
"kind": {
"default": "compute#securityPolicyList",
"description": "[Output Only] Type of resource. Always compute#securityPolicyList for listsof securityPolicies",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SecurityPolicyReference": {
"id": "SecurityPolicyReference",
"properties": {
"securityPolicy": {
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRule": {
"description": "Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).",
"id": "SecurityPolicyRule",
"properties": {
"action": {
"description": "The Action to preform when the client connection triggers the rule. Can currently be either \"allow\" or \"deny()\" where valid values for status are 403, 404, and 502.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"kind": {
"default": "compute#securityPolicyRule",
"description": "[Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules",
"type": "string"
},
"match": {
"$ref": "SecurityPolicyRuleMatcher",
"description": "A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced."
},
"preview": {
"description": "If set to true, the specified action is not enforced.",
"type": "boolean"
},
"priority": {
"description": "An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SecurityPolicyRuleMatcher": {
"description": "Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified.",
"id": "SecurityPolicyRuleMatcher",
"properties": {
"config": {
"$ref": "SecurityPolicyRuleMatcherConfig",
"description": "The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified."
},
"expr": {
"$ref": "Expr",
"description": "User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header."
},
"versionedExpr": {
"description": "Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.",
"enum": [
"SRC_IPS_V1"
],
"enumDescriptions": [
""
],
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRuleMatcherConfig": {
"id": "SecurityPolicyRuleMatcherConfig",
"properties": {
"srcIpRanges": {
"description": "CIDR IP address range.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SerialPortOutput": {
"description": "An instance's serial console output.",
"id": "SerialPortOutput",
"properties": {
"contents": {
"description": "[Output Only] The contents of the console output.",
"type": "string"
},
"kind": {
"default": "compute#serialPortOutput",
"description": "[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output.",
"type": "string"
},
"next": {
"description": "[Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter.",
"format": "int64",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"start": {
"description": "The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ServerBinding": {
"id": "ServerBinding",
"properties": {
"type": {
"enum": [
"RESTART_NODE_ON_ANY_SERVER",
"RESTART_NODE_ON_MINIMAL_SERVERS",
"SERVER_BINDING_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ServiceAccount": {
"description": "A service account.",
"id": "ServiceAccount",
"properties": {
"email": {
"description": "Email address of the service account.",
"type": "string"
},
"scopes": {
"description": "The list of scopes to be made available for this service account.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ShieldedInstanceConfig": {
"description": "A set of Shielded Instance options.",
"id": "ShieldedInstanceConfig",
"properties": {
"enableIntegrityMonitoring": {
"description": "Defines whether the instance has integrity monitoring enabled. Enabled by default.",
"type": "boolean"
},
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled. Disabled by default.",
"type": "boolean"
},
"enableVtpm": {
"description": "Defines whether the instance has the vTPM enabled. Enabled by default.",
"type": "boolean"
}
},
"type": "object"
},
"ShieldedInstanceIdentity": {
"description": "A shielded Instance identity entry.",
"id": "ShieldedInstanceIdentity",
"properties": {
"encryptionKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Endorsement Key (EK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM."
},
"kind": {
"default": "compute#shieldedInstanceIdentity",
"description": "[Output Only] Type of the resource. Always compute#shieldedInstanceIdentity for shielded Instance identity entry.",
"type": "string"
},
"signingKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Attestation Key (AK) made by the RSA 2048 algorithm issued to the Shielded Instance's vTPM."
}
},
"type": "object"
},
"ShieldedInstanceIdentityEntry": {
"description": "A Shielded Instance Identity Entry.",
"id": "ShieldedInstanceIdentityEntry",
"properties": {
"ekCert": {
"description": "A PEM-encoded X.509 certificate. This field can be empty.",
"type": "string"
},
"ekPub": {
"description": "A PEM-encoded public key.",
"type": "string"
}
},
"type": "object"
},
"ShieldedInstanceIntegrityPolicy": {
"description": "The policy describes the baseline against which Instance boot integrity is measured.",
"id": "ShieldedInstanceIntegrityPolicy",
"properties": {
"updateAutoLearnPolicy": {
"description": "Updates the integrity policy baseline using the measurements from the VM instance's most recent boot.",
"type": "boolean"
}
},
"type": "object"
},
"SignedUrlKey": {
"description": "Represents a customer-supplied Signing Key used by Cloud CDN Signed URLs",
"id": "SignedUrlKey",
"properties": {
"keyName": {
"description": "Name of the key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"keyValue": {
"description": "128-bit key value used for signing the URL. The key value must be a valid RFC 4648 Section 5 base64url encoded string.",
"type": "string"
}
},
"type": "object"
},
"Snapshot": {
"description": "Represents a Persistent Disk Snapshot resource.\n\nYou can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for {$api_version}.snapshots ==)",
"id": "Snapshot",
"properties": {
"autoCreated": {
"description": "[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.",
"type": "boolean"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"diskSizeGb": {
"description": "[Output Only] Size of the source disk, specified in GB.",
"format": "int64",
"type": "string"
},
"downloadBytes": {
"description": "[Output Only] Number of bytes downloaded to restore a snapshot to a disk.",
"format": "int64",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#snapshot",
"description": "[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a snapshot.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.",
"type": "object"
},
"licenseCodes": {
"description": "[Output Only] Integer license codes indicating which licenses are attached to this snapshot.",
"items": {
"format": "int64",
"type": "string"
},
"type": "array"
},
"licenses": {
"description": "[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"snapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the snapshot using a customer-supplied encryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later."
},
"sourceDisk": {
"description": "[Output Only] The source disk used to create this snapshot.",
"type": "string"
},
"sourceDiskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key."
},
"sourceDiskId": {
"description": "[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"UPLOADING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"storageBytes": {
"description": "[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.",
"format": "int64",
"type": "string"
},
"storageBytesStatus": {
"description": "[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.",
"enum": [
"UPDATING",
"UP_TO_DATE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the snapshot (regional or multi-regional).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SnapshotList": {
"description": "Contains a list of Snapshot resources.",
"id": "SnapshotList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Snapshot resources.",
"items": {
"$ref": "Snapshot"
},
"type": "array"
},
"kind": {
"default": "compute#snapshotList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SourceInstanceParams": {
"description": "A specification of the parameters to use when creating the instance template from a source instance.",
"id": "SourceInstanceParams",
"properties": {
"diskConfigs": {
"description": "Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.",
"items": {
"$ref": "DiskInstantiationConfig"
},
"type": "array"
}
},
"type": "object"
},
"SslCertificate": {
"description": "Represents an SSL Certificate resource.\n\nGoogle Compute Engine has two SSL Certificate resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/sslCertificates) * [Regional](/compute/docs/reference/rest/{$api_version}/regionSslCertificates)\n\n\n\nThe sslCertificates are used by: \n- external HTTPS load balancers \n- SSL proxy load balancers \n\nThe regionSslCertificates are used by internal HTTPS load balancers.\n\nOptionally, certificate file contents that you upload can contain a set of up to five PEM-encoded certificates. The API call creates an object (sslCertificate) that holds this data. You can use SSL keys and certificates to secure connections to a load balancer. For more information, read Creating and using SSL certificates and SSL certificates quotas and limits. (== resource_for {$api_version}.sslCertificates ==) (== resource_for {$api_version}.regionSslCertificates ==)",
"id": "SslCertificate",
"properties": {
"certificate": {
"description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"expireTime": {
"description": "[Output Only] Expire time of the certificate. RFC3339",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#sslCertificate",
"description": "[Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates.",
"type": "string"
},
"managed": {
"$ref": "SslCertificateManagedSslCertificate",
"description": "Configuration and status of a managed SSL certificate."
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"privateKey": {
"description": "A write-only private key in PEM format. Only insert requests will include this field.",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate.",
"type": "string"
},
"selfLink": {
"description": "[Output only] Server-defined URL for the resource.",
"type": "string"
},
"selfManaged": {
"$ref": "SslCertificateSelfManagedSslCertificate",
"description": "Configuration and status of a self-managed SSL certificate."
},
"subjectAlternativeNames": {
"description": "[Output Only] Domains associated with the certificate via Subject Alternative Name.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or \"MANAGED\". If not specified, the certificate is self-managed and the fields certificate and private_key are used.",
"enum": [
"MANAGED",
"SELF_MANAGED",
"TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SslCertificateAggregatedList": {
"id": "SslCertificateAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "SslCertificatesScopedList",
"description": "Name of the scope containing this set of SslCertificates."
},
"description": "A list of SslCertificatesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#sslCertificateAggregatedList",
"description": "[Output Only] Type of resource. Always compute#sslCertificateAggregatedList for lists of SSL Certificates.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SslCertificateList": {
"description": "Contains a list of SslCertificate resources.",
"id": "SslCertificateList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of SslCertificate resources.",
"items": {
"$ref": "SslCertificate"
},
"type": "array"
},
"kind": {
"default": "compute#sslCertificateList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SslCertificateManagedSslCertificate": {
"description": "Configuration and status of a managed SSL certificate.",
"id": "SslCertificateManagedSslCertificate",
"properties": {
"domainStatus": {
"additionalProperties": {
"enum": [
"ACTIVE",
"DOMAIN_STATUS_UNSPECIFIED",
"FAILED_CAA_CHECKING",
"FAILED_CAA_FORBIDDEN",
"FAILED_NOT_VISIBLE",
"FAILED_RATE_LIMITED",
"PROVISIONING"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"description": "[Output only] Detailed statuses of the domains specified for managed certificate resource.",
"type": "object"
},
"domains": {
"description": "The domains for which a managed SSL certificate will be generated. Currently only single-domain certs are supported.",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "[Output only] Status of the managed certificate resource.",
"enum": [
"ACTIVE",
"MANAGED_CERTIFICATE_STATUS_UNSPECIFIED",
"PROVISIONING",
"PROVISIONING_FAILED",
"PROVISIONING_FAILED_PERMANENTLY",
"RENEWAL_FAILED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SslCertificateSelfManagedSslCertificate": {
"description": "Configuration and status of a self-managed SSL certificate.",
"id": "SslCertificateSelfManagedSslCertificate",
"properties": {
"certificate": {
"description": "A local certificate file. The certificate must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert.",
"type": "string"
},
"privateKey": {
"description": "A write-only private key in PEM format. Only insert requests will include this field.",
"type": "string"
}
},
"type": "object"
},
"SslCertificatesScopedList": {
"id": "SslCertificatesScopedList",
"properties": {
"sslCertificates": {
"description": "List of SslCertificates contained in this scope.",
"items": {
"$ref": "SslCertificate"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SslPoliciesList": {
"id": "SslPoliciesList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of SslPolicy resources.",
"items": {
"$ref": "SslPolicy"
},
"type": "array"
},
"kind": {
"default": "compute#sslPoliciesList",
"description": "[Output Only] Type of the resource. Always compute#sslPoliciesList for lists of sslPolicies.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SslPoliciesListAvailableFeaturesResponse": {
"id": "SslPoliciesListAvailableFeaturesResponse",
"properties": {
"features": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SslPolicy": {
"description": "Represents a Cloud Armor Security Policy resource.\n\nOnly external backend services used by HTTP or HTTPS load balancers can reference a Security Policy. For more information, read read Cloud Armor Security Policy Concepts. (== resource_for {$api_version}.sslPolicies ==)",
"id": "SslPolicy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"customFeatures": {
"description": "A list of features enabled when the selected profile is CUSTOM. The\n- method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"enabledFeatures": {
"description": "[Output Only] The list of features enabled in the SSL policy.",
"items": {
"type": "string"
},
"type": "array"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an SslPolicy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#sslPolicy",
"description": "[Output only] Type of the resource. Always compute#sslPolicyfor SSL policies.",
"type": "string"
},
"minTlsVersion": {
"description": "The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2.",
"enum": [
"TLS_1_0",
"TLS_1_1",
"TLS_1_2"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"name": {
"description": "Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"profile": {
"description": "Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field.",
"enum": [
"COMPATIBLE",
"CUSTOM",
"MODERN",
"RESTRICTED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"warnings": {
"description": "[Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"SslPolicyReference": {
"id": "SslPolicyReference",
"properties": {
"sslPolicy": {
"description": "URL of the SSL policy resource. Set this to empty string to clear any existing SSL policy associated with the target proxy resource.",
"type": "string"
}
},
"type": "object"
},
"Subnetwork": {
"description": "Represents a Subnetwork resource.\n\nA subnetwork (also known as a subnet) is a logical partition of a Virtual Private Cloud network with one primary IP range and zero or more secondary IP ranges. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for {$api_version}.subnetworks ==)",
"id": "Subnetwork",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time.",
"type": "string"
},
"enableFlowLogs": {
"description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging. This field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
"type": "boolean"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a Subnetwork.",
"format": "byte",
"type": "string"
},
"gatewayAddress": {
"description": "[Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"ipCidrRange": {
"description": "The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time.",
"type": "string"
},
"ipv6CidrRange": {
"description": "[Output Only] The range of internal IPv6 addresses that are owned by this subnetwork.",
"type": "string"
},
"kind": {
"default": "compute#subnetwork",
"description": "[Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources.",
"type": "string"
},
"logConfig": {
"$ref": "SubnetworkLogConfig",
"description": "This field denotes the VPC flow logging options for this subnetwork. If logging is enabled, logs are exported to Stackdriver."
},
"name": {
"description": "The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time.",
"type": "string"
},
"privateIpGoogleAccess": {
"description": "Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess.",
"type": "boolean"
},
"privateIpv6GoogleAccess": {
"description": "The private IPv6 google access type for the VMs in this subnet. This is an expanded field of enablePrivateV6Access. If both fields are set, privateIpv6GoogleAccess will take priority.\n\nThis field can be both set at resource creation time and updated using patch.",
"enum": [
"DISABLE_GOOGLE_ACCESS",
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"purpose": {
"description": "The purpose of the resource. This field can be either PRIVATE_RFC_1918 or INTERNAL_HTTPS_LOAD_BALANCER. A subnetwork with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a user-created subnetwork that is reserved for Internal HTTP(S) Load Balancing. If unspecified, the purpose defaults to PRIVATE_RFC_1918. The enableFlowLogs field isn't supported with the purpose field set to INTERNAL_HTTPS_LOAD_BALANCER.",
"enum": [
"INTERNAL_HTTPS_LOAD_BALANCER",
"PRIVATE",
"PRIVATE_RFC_1918"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"region": {
"description": "URL of the region where the Subnetwork resides. This field can be set only at resource creation time.",
"type": "string"
},
"role": {
"description": "The role of subnetwork. Currently, this field is only used when purpose = INTERNAL_HTTPS_LOAD_BALANCER. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Internal HTTP(S) Load Balancing. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request.",
"enum": [
"ACTIVE",
"BACKUP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"secondaryIpRanges": {
"description": "An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request.",
"items": {
"$ref": "SubnetworkSecondaryRange"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"state": {
"description": "[Output Only] The state of the subnetwork, which can be one of READY or DRAINING. A subnetwork that is READY is ready to be used. The state of DRAINING is only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY.",
"enum": [
"DRAINING",
"READY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SubnetworkAggregatedList": {
"id": "SubnetworkAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "SubnetworksScopedList",
"description": "Name of the scope containing this set of Subnetworks."
},
"description": "A list of SubnetworksScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#subnetworkAggregatedList",
"description": "[Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SubnetworkList": {
"description": "Contains a list of Subnetwork resources.",
"id": "SubnetworkList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Subnetwork resources.",
"items": {
"$ref": "Subnetwork"
},
"type": "array"
},
"kind": {
"default": "compute#subnetworkList",
"description": "[Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SubnetworkLogConfig": {
"description": "The available logging options for this subnetwork.",
"id": "SubnetworkLogConfig",
"properties": {
"aggregationInterval": {
"description": "Can only be specified if VPC flow logging for this subnetwork is enabled. Toggles the aggregation interval for collecting flow logs. Increasing the interval time will reduce the amount of generated flow logs for long lasting connections. Default is an interval of 5 seconds per connection.",
"enum": [
"INTERVAL_10_MIN",
"INTERVAL_15_MIN",
"INTERVAL_1_MIN",
"INTERVAL_30_SEC",
"INTERVAL_5_MIN",
"INTERVAL_5_SEC"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"enable": {
"description": "Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is to disable flow logging.",
"type": "boolean"
},
"filterExpr": {
"description": "Can only be specified if VPC flow logs for this subnetwork is enabled. Export filter used to define which VPC flow logs should be logged.",
"type": "string"
},
"flowSampling": {
"description": "Can only be specified if VPC flow logging for this subnetwork is enabled. The value of the field must be in [0, 1]. Set the sampling rate of VPC flow logs within the subnetwork where 1.0 means all collected logs are reported and 0.0 means no logs are reported. Default is 0.5, which means half of all collected logs are reported.",
"format": "float",
"type": "number"
},
"metadata": {
"description": "Can only be specified if VPC flow logs for this subnetwork is enabled. Configures whether all, none or a subset of metadata fields should be added to the reported VPC flow logs. Default is INCLUDE_ALL_METADATA.",
"enum": [
"CUSTOM_METADATA",
"EXCLUDE_ALL_METADATA",
"INCLUDE_ALL_METADATA"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"metadataFields": {
"description": "Can only be specified if VPC flow logs for this subnetwork is enabled and \"metadata\" was set to CUSTOM_METADATA.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SubnetworkSecondaryRange": {
"description": "Represents a secondary IP range of a subnetwork.",
"id": "SubnetworkSecondaryRange",
"properties": {
"ipCidrRange": {
"description": "The range of IP addresses belonging to this subnetwork secondary range. Provide this property when you create the subnetwork. Ranges must be unique and non-overlapping with all primary and secondary IP ranges within a network. Only IPv4 is supported.",
"type": "string"
},
"rangeName": {
"description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.",
"type": "string"
}
},
"type": "object"
},
"SubnetworksExpandIpCidrRangeRequest": {
"id": "SubnetworksExpandIpCidrRangeRequest",
"properties": {
"ipCidrRange": {
"description": "The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update.",
"type": "string"
}
},
"type": "object"
},
"SubnetworksScopedList": {
"id": "SubnetworksScopedList",
"properties": {
"subnetworks": {
"description": "A list of subnetworks contained in this scope.",
"items": {
"$ref": "Subnetwork"
},
"type": "array"
},
"warning": {
"description": "An informational warning that appears when the list of addresses is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"SubnetworksSetPrivateIpGoogleAccessRequest": {
"id": "SubnetworksSetPrivateIpGoogleAccessRequest",
"properties": {
"privateIpGoogleAccess": {
"type": "boolean"
}
},
"type": "object"
},
"TCPHealthCheck": {
"id": "TCPHealthCheck",
"properties": {
"port": {
"description": "The TCP port number for the health check request. The default value is 80. Valid values are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how port is selected for health checking, can be one of following values:\nUSE_FIXED_PORT: The port number in port is used for health checking.\nUSE_NAMED_PORT: The portName is used for health checking.\nUSE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking.\n\n\nIf not specified, TCP health check follows behavior specified in port and portName fields.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"request": {
"description": "The application data to send once the TCP connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.",
"type": "string"
},
"response": {
"description": "The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.",
"type": "string"
}
},
"type": "object"
},
"Tags": {
"description": "A set of instance tags.",
"id": "Tags",
"properties": {
"fingerprint": {
"description": "Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.\n\nTo see the latest fingerprint, make get() request to the instance.",
"format": "byte",
"type": "string"
},
"items": {
"description": "An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TargetHttpProxiesScopedList": {
"id": "TargetHttpProxiesScopedList",
"properties": {
"targetHttpProxies": {
"description": "A list of TargetHttpProxies contained in this scope.",
"items": {
"$ref": "TargetHttpProxy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetHttpProxy": {
"description": "Represents a Target HTTP Proxy resource.\n\nGoogle Compute Engine has two Target HTTP Proxy resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/targetHttpProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpProxies)\n\nA target HTTP proxy is a component of GCP HTTP load balancers.\n\n* targetHttpProxies are used by external HTTP load balancers and Traffic Director. * regionTargetHttpProxies are used by internal HTTP load balancers.\n\nForwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpProxies ==) (== resource_for {$api_version}.regionTargetHttpProxies ==)",
"id": "TargetHttpProxy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetHttpProxy",
"description": "[Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"urlMap": {
"description": "URL to the UrlMap resource that defines the mapping from URL to the BackendService.",
"type": "string"
}
},
"type": "object"
},
"TargetHttpProxyAggregatedList": {
"id": "TargetHttpProxyAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetHttpProxiesScopedList",
"description": "Name of the scope containing this set of TargetHttpProxies."
},
"description": "A list of TargetHttpProxiesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#targetHttpProxyAggregatedList",
"description": "[Output Only] Type of resource. Always compute#targetHttpProxyAggregatedList for lists of Target HTTP Proxies.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
}
},
"type": "object"
},
"TargetHttpProxyList": {
"description": "A list of TargetHttpProxy resources.",
"id": "TargetHttpProxyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetHttpProxy resources.",
"items": {
"$ref": "TargetHttpProxy"
},
"type": "array"
},
"kind": {
"default": "compute#targetHttpProxyList",
"description": "Type of resource. Always compute#targetHttpProxyList for lists of target HTTP proxies.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetHttpsProxiesScopedList": {
"id": "TargetHttpsProxiesScopedList",
"properties": {
"targetHttpsProxies": {
"description": "A list of TargetHttpsProxies contained in this scope.",
"items": {
"$ref": "TargetHttpsProxy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetHttpsProxiesSetQuicOverrideRequest": {
"id": "TargetHttpsProxiesSetQuicOverrideRequest",
"properties": {
"quicOverride": {
"description": "QUIC policy for the TargetHttpsProxy resource.",
"enum": [
"DISABLE",
"ENABLE",
"NONE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"TargetHttpsProxiesSetSslCertificatesRequest": {
"id": "TargetHttpsProxiesSetSslCertificatesRequest",
"properties": {
"sslCertificates": {
"description": "New set of SslCertificate resources to associate with this TargetHttpsProxy resource. Currently exactly one SslCertificate resource must be specified.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TargetHttpsProxy": {
"description": "Represents a Target HTTPS Proxy resource.\n\nGoogle Compute Engine has two Target HTTPS Proxy resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/targetHttpsProxies) * [Regional](/compute/docs/reference/rest/{$api_version}/regionTargetHttpsProxies)\n\nA target HTTPS proxy is a component of GCP HTTPS load balancers.\n\n* targetHttpsProxies are used by external HTTPS load balancers. * regionTargetHttpsProxies are used by internal HTTPS load balancers.\n\nForwarding rules reference a target HTTPS proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. (== resource_for {$api_version}.targetHttpsProxies ==) (== resource_for {$api_version}.regionTargetHttpsProxies ==)",
"id": "TargetHttpsProxy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetHttpsProxy",
"description": "[Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"quicOverride": {
"description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. \n- When quic-override is set to NONE, Google manages whether QUIC is used. \n- When quic-override is set to ENABLE, the load balancer uses QUIC when possible. \n- When quic-override is set to DISABLE, the load balancer doesn't use QUIC. \n- If the quic-override flag is not specified, NONE is implied.\n-",
"enum": [
"DISABLE",
"ENABLE",
"NONE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sslCertificates": {
"description": "URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.",
"items": {
"type": "string"
},
"type": "array"
},
"sslPolicy": {
"description": "URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured.",
"type": "string"
},
"urlMap": {
"description": "A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: \n- https://www.googleapis.compute/v1/projects/project/global/urlMaps/url-map \n- projects/project/global/urlMaps/url-map \n- global/urlMaps/url-map",
"type": "string"
}
},
"type": "object"
},
"TargetHttpsProxyAggregatedList": {
"id": "TargetHttpsProxyAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetHttpsProxiesScopedList",
"description": "Name of the scope containing this set of TargetHttpsProxies."
},
"description": "A list of TargetHttpsProxiesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#targetHttpsProxyAggregatedList",
"description": "[Output Only] Type of resource. Always compute#targetHttpsProxyAggregatedList for lists of Target HTTP Proxies.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetHttpsProxyList": {
"description": "Contains a list of TargetHttpsProxy resources.",
"id": "TargetHttpsProxyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetHttpsProxy resources.",
"items": {
"$ref": "TargetHttpsProxy"
},
"type": "array"
},
"kind": {
"default": "compute#targetHttpsProxyList",
"description": "Type of resource. Always compute#targetHttpsProxyList for lists of target HTTPS proxies.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetInstance": {
"description": "Represents a Target Instance resource.\n\nYou can use a target instance to handle traffic for one or more forwarding rules, which is ideal for forwarding protocol traffic that is managed by a single source. For example, ESP, AH, TCP, or UDP. For more information, read Target instances. (== resource_for {$api_version}.targetInstances ==)",
"id": "TargetInstance",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"instance": {
"description": "A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n- projects/project/zones/zone/instances/instance \n- zones/zone/instances/instance",
"type": "string"
},
"kind": {
"default": "compute#targetInstance",
"description": "[Output Only] The type of the resource. Always compute#targetInstance for target instances.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"natPolicy": {
"description": "NAT option controlling how IPs are NAT'ed to the instance. Currently only NO_NAT (default value) is supported.",
"enum": [
"NO_NAT"
],
"enumDescriptions": [
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"zone": {
"description": "[Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"TargetInstanceAggregatedList": {
"id": "TargetInstanceAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetInstancesScopedList",
"description": "Name of the scope containing this set of target instances."
},
"description": "A list of TargetInstance resources.",
"type": "object"
},
"kind": {
"default": "compute#targetInstanceAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetInstanceList": {
"description": "Contains a list of TargetInstance resources.",
"id": "TargetInstanceList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetInstance resources.",
"items": {
"$ref": "TargetInstance"
},
"type": "array"
},
"kind": {
"default": "compute#targetInstanceList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetInstancesScopedList": {
"id": "TargetInstancesScopedList",
"properties": {
"targetInstances": {
"description": "A list of target instances contained in this scope.",
"items": {
"$ref": "TargetInstance"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetPool": {
"description": "Represents a Target Pool resource.\n\nTarget pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools. (== resource_for {$api_version}.targetPools ==)",
"id": "TargetPool",
"properties": {
"backupPool": {
"description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1].\n\nbackupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"failoverRatio": {
"description": "This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1].\n\nIf set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool.\n\nIn case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the \"force\" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.",
"format": "float",
"type": "number"
},
"healthChecks": {
"description": "The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"instances": {
"description": "A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"default": "compute#targetPool",
"description": "[Output Only] Type of the resource. Always compute#targetPool for target pools.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the target pool resides.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sessionAffinity": {
"description": "Session affinity option, must be one of the following values:\nNONE: Connections from the same client IP may go to any instance in the pool.\nCLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy.\nCLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy.",
"enum": [
"CLIENT_IP",
"CLIENT_IP_PORT_PROTO",
"CLIENT_IP_PROTO",
"GENERATED_COOKIE",
"HEADER_FIELD",
"HTTP_COOKIE",
"NONE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"TargetPoolAggregatedList": {
"id": "TargetPoolAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetPoolsScopedList",
"description": "Name of the scope containing this set of target pools."
},
"description": "A list of TargetPool resources.",
"type": "object"
},
"kind": {
"default": "compute#targetPoolAggregatedList",
"description": "[Output Only] Type of resource. Always compute#targetPoolAggregatedList for aggregated lists of target pools.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetPoolInstanceHealth": {
"id": "TargetPoolInstanceHealth",
"properties": {
"healthStatus": {
"items": {
"$ref": "HealthStatus"
},
"type": "array"
},
"kind": {
"default": "compute#targetPoolInstanceHealth",
"description": "[Output Only] Type of resource. Always compute#targetPoolInstanceHealth when checking the health of an instance.",
"type": "string"
}
},
"type": "object"
},
"TargetPoolList": {
"description": "Contains a list of TargetPool resources.",
"id": "TargetPoolList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetPool resources.",
"items": {
"$ref": "TargetPool"
},
"type": "array"
},
"kind": {
"default": "compute#targetPoolList",
"description": "[Output Only] Type of resource. Always compute#targetPoolList for lists of target pools.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetPoolsAddHealthCheckRequest": {
"id": "TargetPoolsAddHealthCheckRequest",
"properties": {
"healthChecks": {
"description": "The HttpHealthCheck to add to the target pool.",
"items": {
"$ref": "HealthCheckReference"
},
"type": "array"
}
},
"type": "object"
},
"TargetPoolsAddInstanceRequest": {
"id": "TargetPoolsAddInstanceRequest",
"properties": {
"instances": {
"description": "A full or partial URL to an instance to add to this target pool. This can be a full or partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/v1/projects/project-id/zones/zone/instances/instance-name \n- projects/project-id/zones/zone/instances/instance-name \n- zones/zone/instances/instance-name",
"items": {
"$ref": "InstanceReference"
},
"type": "array"
}
},
"type": "object"
},
"TargetPoolsRemoveHealthCheckRequest": {
"id": "TargetPoolsRemoveHealthCheckRequest",
"properties": {
"healthChecks": {
"description": "Health check URL to be removed. This can be a full or valid partial URL. For example, the following are valid URLs: \n- https://www.googleapis.com/compute/beta/projects/project/global/httpHealthChecks/health-check \n- projects/project/global/httpHealthChecks/health-check \n- global/httpHealthChecks/health-check",
"items": {
"$ref": "HealthCheckReference"
},
"type": "array"
}
},
"type": "object"
},
"TargetPoolsRemoveInstanceRequest": {
"id": "TargetPoolsRemoveInstanceRequest",
"properties": {
"instances": {
"description": "URLs of the instances to be removed from target pool.",
"items": {
"$ref": "InstanceReference"
},
"type": "array"
}
},
"type": "object"
},
"TargetPoolsScopedList": {
"id": "TargetPoolsScopedList",
"properties": {
"targetPools": {
"description": "A list of target pools contained in this scope.",
"items": {
"$ref": "TargetPool"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetReference": {
"id": "TargetReference",
"properties": {
"target": {
"type": "string"
}
},
"type": "object"
},
"TargetSslProxiesSetBackendServiceRequest": {
"id": "TargetSslProxiesSetBackendServiceRequest",
"properties": {
"service": {
"description": "The URL of the new BackendService resource for the targetSslProxy.",
"type": "string"
}
},
"type": "object"
},
"TargetSslProxiesSetProxyHeaderRequest": {
"id": "TargetSslProxiesSetProxyHeaderRequest",
"properties": {
"proxyHeader": {
"description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"TargetSslProxiesSetSslCertificatesRequest": {
"id": "TargetSslProxiesSetSslCertificatesRequest",
"properties": {
"sslCertificates": {
"description": "New set of URLs to SslCertificate resources to associate with this TargetSslProxy. Currently exactly one ssl certificate must be specified.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TargetSslProxy": {
"description": "Represents a Target SSL Proxy resource.\n\nA target SSL proxy is a component of a SSL Proxy load balancer. Global forwarding rules reference a target SSL proxy, and the target proxy then references an external backend service. For more information, read Using Target Proxies. (== resource_for {$api_version}.targetSslProxies ==)",
"id": "TargetSslProxy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetSslProxy",
"description": "[Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"service": {
"description": "URL to the BackendService resource.",
"type": "string"
},
"sslCertificates": {
"description": "URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates.",
"items": {
"type": "string"
},
"type": "array"
},
"sslPolicy": {
"description": "URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured.",
"type": "string"
}
},
"type": "object"
},
"TargetSslProxyList": {
"description": "Contains a list of TargetSslProxy resources.",
"id": "TargetSslProxyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetSslProxy resources.",
"items": {
"$ref": "TargetSslProxy"
},
"type": "array"
},
"kind": {
"default": "compute#targetSslProxyList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetTcpProxiesSetBackendServiceRequest": {
"id": "TargetTcpProxiesSetBackendServiceRequest",
"properties": {
"service": {
"description": "The URL of the new BackendService resource for the targetTcpProxy.",
"type": "string"
}
},
"type": "object"
},
"TargetTcpProxiesSetProxyHeaderRequest": {
"id": "TargetTcpProxiesSetProxyHeaderRequest",
"properties": {
"proxyHeader": {
"description": "The new type of proxy header to append before sending data to the backend. NONE or PROXY_V1 are allowed.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"TargetTcpProxy": {
"description": "Represents a Target TCP Proxy resource.\n\nA target TCP proxy is a component of a TCP Proxy load balancer. Global forwarding rules reference target TCP proxy, and the target proxy then references an external backend service. For more information, read TCP Proxy Load Balancing overview. (== resource_for {$api_version}.targetTcpProxies ==)",
"id": "TargetTcpProxy",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetTcpProxy",
"description": "[Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"service": {
"description": "URL to the BackendService resource.",
"type": "string"
}
},
"type": "object"
},
"TargetTcpProxyList": {
"description": "Contains a list of TargetTcpProxy resources.",
"id": "TargetTcpProxyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetTcpProxy resources.",
"items": {
"$ref": "TargetTcpProxy"
},
"type": "array"
},
"kind": {
"default": "compute#targetTcpProxyList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetVpnGateway": {
"description": "Represents a Target VPN Gateway resource.\n\nThe target VPN gateway resource represents a Classic Cloud VPN gateway. For more information, read the the Cloud VPN Overview. (== resource_for {$api_version}.targetVpnGateways ==)",
"id": "TargetVpnGateway",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"forwardingRules": {
"description": "[Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetVpnGateway",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.targetVpnGateways.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"annotations": {
"required": [
"compute.targetVpnGateways.insert"
]
},
"description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"tunnels": {
"description": "[Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TargetVpnGatewayAggregatedList": {
"id": "TargetVpnGatewayAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetVpnGatewaysScopedList",
"description": "[Output Only] Name of the scope containing this set of target VPN gateways."
},
"description": "A list of TargetVpnGateway resources.",
"type": "object"
},
"kind": {
"default": "compute#targetVpnGatewayAggregatedList",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetVpnGatewayList": {
"description": "Contains a list of TargetVpnGateway resources.",
"id": "TargetVpnGatewayList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetVpnGateway resources.",
"items": {
"$ref": "TargetVpnGateway"
},
"type": "array"
},
"kind": {
"default": "compute#targetVpnGatewayList",
"description": "[Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TargetVpnGatewaysScopedList": {
"id": "TargetVpnGatewaysScopedList",
"properties": {
"targetVpnGateways": {
"description": "[Output Only] A list of target VPN gateways contained in this scope.",
"items": {
"$ref": "TargetVpnGateway"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"TestFailure": {
"id": "TestFailure",
"properties": {
"actualService": {
"type": "string"
},
"expectedService": {
"type": "string"
},
"host": {
"type": "string"
},
"path": {
"type": "string"
}
},
"type": "object"
},
"TestPermissionsRequest": {
"id": "TestPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestPermissionsResponse": {
"id": "TestPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"UrlMap": {
"description": "Represents a URL Map resource.\n\nGoogle Compute Engine has two URL Map resources:\n\n* [Global](/compute/docs/reference/rest/{$api_version}/urlMaps) * [Regional](/compute/docs/reference/rest/{$api_version}/regionUrlMaps)\n\nA URL map resource is a component of certain types of GCP load balancers and Traffic Director.\n\n* urlMaps are used by external HTTP(S) load balancers and Traffic Director. * regionUrlMaps are used by internal HTTP(S) load balancers.\n\nThis resource defines mappings from host names and URL paths to either a backend service or a backend bucket.\n\nTo use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.",
"id": "UrlMap",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"defaultRouteAction": {
"$ref": "HttpRouteAction",
"description": "defaultRouteAction takes effect when none of the hostRules match. The load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If defaultRouteAction specifies any weightedBackendServices, defaultService must not be set. Conversely if defaultService is set, defaultRouteAction cannot contain any weightedBackendServices.\nOnly one of defaultRouteAction or defaultUrlRedirect must be set."
},
"defaultService": {
"description": "The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is additionally specified, advanced routing actions like URL Rewrites, etc. take effect prior to sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified.\nOnly one of defaultService, defaultUrlRedirect or defaultRouteAction.weightedBackendService must be set.",
"type": "string"
},
"defaultUrlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect.\nIf defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set."
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve a UrlMap.",
"format": "byte",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect for the selected backendService.\nThe headerAction specified here take effect after headerAction specified under pathMatcher."
},
"hostRules": {
"description": "The list of HostRules to use against the URL.",
"items": {
"$ref": "HostRule"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#urlMap",
"description": "[Output Only] Type of the resource. Always compute#urlMaps for url maps.",
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"pathMatchers": {
"description": "The list of named PathMatchers to use against the URL.",
"items": {
"$ref": "PathMatcher"
},
"type": "array"
},
"region": {
"description": "[Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"tests": {
"description": "The list of expected URL mapping tests. Request to update this UrlMap will succeed only if all of the test cases pass. You can specify a maximum of 100 tests per UrlMap.",
"items": {
"$ref": "UrlMapTest"
},
"type": "array"
}
},
"type": "object"
},
"UrlMapList": {
"description": "Contains a list of UrlMap resources.",
"id": "UrlMapList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of UrlMap resources.",
"items": {
"$ref": "UrlMap"
},
"type": "array"
},
"kind": {
"default": "compute#urlMapList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"UrlMapReference": {
"id": "UrlMapReference",
"properties": {
"urlMap": {
"type": "string"
}
},
"type": "object"
},
"UrlMapTest": {
"description": "Message for the expected URL mappings.",
"id": "UrlMapTest",
"properties": {
"description": {
"description": "Description of this test case.",
"type": "string"
},
"host": {
"description": "Host portion of the URL.",
"type": "string"
},
"path": {
"description": "Path portion of the URL.",
"type": "string"
},
"service": {
"description": "Expected BackendService resource the given URL should be mapped to.",
"type": "string"
}
},
"type": "object"
},
"UrlMapValidationResult": {
"description": "Message representing the validation result for a UrlMap.",
"id": "UrlMapValidationResult",
"properties": {
"loadErrors": {
"items": {
"type": "string"
},
"type": "array"
},
"loadSucceeded": {
"description": "Whether the given UrlMap can be successfully loaded. If false, 'loadErrors' indicates the reasons.",
"type": "boolean"
},
"testFailures": {
"items": {
"$ref": "TestFailure"
},
"type": "array"
},
"testPassed": {
"description": "If successfully loaded, this field indicates whether the test passed. If false, 'testFailures's indicate the reason of failure.",
"type": "boolean"
}
},
"type": "object"
},
"UrlMapsAggregatedList": {
"id": "UrlMapsAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "UrlMapsScopedList",
"description": "Name of the scope containing this set of UrlMaps."
},
"description": "A list of UrlMapsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#urlMapsAggregatedList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"UrlMapsScopedList": {
"id": "UrlMapsScopedList",
"properties": {
"urlMaps": {
"description": "A list of UrlMaps contained in this scope.",
"items": {
"$ref": "UrlMap"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of backend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"UrlMapsValidateRequest": {
"id": "UrlMapsValidateRequest",
"properties": {
"resource": {
"$ref": "UrlMap",
"description": "Content of the UrlMap to be validated."
}
},
"type": "object"
},
"UrlMapsValidateResponse": {
"id": "UrlMapsValidateResponse",
"properties": {
"result": {
"$ref": "UrlMapValidationResult"
}
},
"type": "object"
},
"UrlRewrite": {
"description": "The spec for modifying the path before sending the request to the matched backend service.",
"id": "UrlRewrite",
"properties": {
"hostRewrite": {
"description": "Prior to forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite.\nThe value must be between 1 and 255 characters.",
"type": "string"
},
"pathPrefixRewrite": {
"description": "Prior to forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite.\nThe value must be between 1 and 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"UsableSubnetwork": {
"description": "Subnetwork which the current user has compute.subnetworks.use permission on.",
"id": "UsableSubnetwork",
"properties": {
"ipCidrRange": {
"description": "The range of internal addresses that are owned by this subnetwork.",
"type": "string"
},
"network": {
"description": "Network URL.",
"type": "string"
},
"secondaryIpRanges": {
"description": "Secondary IP ranges.",
"items": {
"$ref": "UsableSubnetworkSecondaryRange"
},
"type": "array"
},
"subnetwork": {
"description": "Subnetwork URL.",
"type": "string"
}
},
"type": "object"
},
"UsableSubnetworkSecondaryRange": {
"description": "Secondary IP range of a usable subnetwork.",
"id": "UsableSubnetworkSecondaryRange",
"properties": {
"ipCidrRange": {
"description": "The range of IP addresses belonging to this subnetwork secondary range.",
"type": "string"
},
"rangeName": {
"description": "The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance. The name must be 1-63 characters long, and comply with RFC1035. The name must be unique within the subnetwork.",
"type": "string"
}
},
"type": "object"
},
"UsableSubnetworksAggregatedList": {
"id": "UsableSubnetworksAggregatedList",
"properties": {
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"items": {
"description": "[Output] A list of usable subnetwork URLs.",
"items": {
"$ref": "UsableSubnetwork"
},
"type": "array"
},
"kind": {
"default": "compute#usableSubnetworksAggregatedList",
"description": "[Output Only] Type of resource. Always compute#usableSubnetworksAggregatedList for aggregated lists of usable subnetworks.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"UsageExportLocation": {
"description": "The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix.",
"id": "UsageExportLocation",
"properties": {
"bucketName": {
"description": "The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket.",
"type": "string"
},
"reportNamePrefix": {
"description": "An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions.",
"type": "string"
}
},
"type": "object"
},
"VmEndpointNatMappings": {
"description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC).",
"id": "VmEndpointNatMappings",
"properties": {
"instanceName": {
"description": "Name of the VM instance which the endpoint belongs to",
"type": "string"
},
"interfaceNatMappings": {
"items": {
"$ref": "VmEndpointNatMappingsInterfaceNatMappings"
},
"type": "array"
}
},
"type": "object"
},
"VmEndpointNatMappingsInterfaceNatMappings": {
"description": "Contain information of Nat mapping for an interface of this endpoint.",
"id": "VmEndpointNatMappingsInterfaceNatMappings",
"properties": {
"drainNatIpPortRanges": {
"description": "List of all drain IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"type": "array"
},
"natIpPortRanges": {
"description": "A list of all IP:port-range mappings assigned to this interface. These ranges are inclusive, that is, both the first and the last ports can be used for NAT. Example: [\"2.2.2.2:12345-12355\", \"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"type": "array"
},
"numTotalDrainNatPorts": {
"description": "Total number of drain ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field drain_nat_ip_port_ranges.",
"format": "int32",
"type": "integer"
},
"numTotalNatPorts": {
"description": "Total number of ports across all NAT IPs allocated to this interface. It equals to the aggregated port number in the field nat_ip_port_ranges.",
"format": "int32",
"type": "integer"
},
"sourceAliasIpRange": {
"description": "Alias IP range for this interface endpoint. It will be a private (RFC 1918) IP range. Examples: \"10.33.4.55/32\", or \"192.168.5.0/24\".",
"type": "string"
},
"sourceVirtualIp": {
"description": "Primary IP of the VM for this NIC.",
"type": "string"
}
},
"type": "object"
},
"VmEndpointNatMappingsList": {
"description": "Contains a list of VmEndpointNatMappings.",
"id": "VmEndpointNatMappingsList",
"properties": {
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"type": "string"
},
"kind": {
"default": "compute#vmEndpointNatMappingsList",
"description": "[Output Only] Type of resource. Always compute#vmEndpointNatMappingsList for lists of Nat mappings of VM endpoints.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"result": {
"description": "[Output Only] A list of Nat mapping information of VM endpoints.",
"items": {
"$ref": "VmEndpointNatMappings"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnGateway": {
"description": "Represents a HA VPN gateway.\n\nHA VPN is a high-availability (HA) Cloud VPN solution that lets you securely connect your on-premises network to your Google Cloud Virtual Private Cloud network through an IPsec VPN connection in a single region. For more information about Cloud HA VPN solutions, see Cloud VPN topologies . (== resource_for {$api_version}.vpnGateways ==)",
"id": "VpnGateway",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#vpnGateway",
"description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to retrieve an VpnGateway.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.vpnGateways.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"annotations": {
"required": [
"compute.vpnGateways.insert"
]
},
"description": "URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created.",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the VPN gateway resides.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"vpnInterfaces": {
"description": "A list of interfaces on this VPN gateway.",
"items": {
"$ref": "VpnGatewayVpnGatewayInterface"
},
"type": "array"
}
},
"type": "object"
},
"VpnGatewayAggregatedList": {
"id": "VpnGatewayAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "VpnGatewaysScopedList",
"description": "[Output Only] Name of the scope containing this set of VPN gateways."
},
"description": "A list of VpnGateway resources.",
"type": "object"
},
"kind": {
"default": "compute#vpnGatewayAggregatedList",
"description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnGatewayList": {
"description": "Contains a list of VpnGateway resources.",
"id": "VpnGatewayList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of VpnGateway resources.",
"items": {
"$ref": "VpnGateway"
},
"type": "array"
},
"kind": {
"default": "compute#vpnGatewayList",
"description": "[Output Only] Type of resource. Always compute#vpnGateway for VPN gateways.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnGatewayStatus": {
"id": "VpnGatewayStatus",
"properties": {
"vpnConnections": {
"description": "List of VPN connection for this VpnGateway.",
"items": {
"$ref": "VpnGatewayStatusVpnConnection"
},
"type": "array"
}
},
"type": "object"
},
"VpnGatewayStatusHighAvailabilityRequirementState": {
"description": "Describes the high availability requirement state for the VPN connection between this Cloud VPN gateway and a peer gateway.",
"id": "VpnGatewayStatusHighAvailabilityRequirementState",
"properties": {
"state": {
"description": "Indicates the high availability requirement state for the VPN connection. Valid values are CONNECTION_REDUNDANCY_MET, CONNECTION_REDUNDANCY_NOT_MET.",
"enum": [
"CONNECTION_REDUNDANCY_MET",
"CONNECTION_REDUNDANCY_NOT_MET"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"unsatisfiedReason": {
"description": "Indicates the reason why the VPN connection does not meet the high availability redundancy criteria/requirement. Valid values is INCOMPLETE_TUNNELS_COVERAGE.",
"enum": [
"INCOMPLETE_TUNNELS_COVERAGE"
],
"enumDescriptions": [
""
],
"type": "string"
}
},
"type": "object"
},
"VpnGatewayStatusTunnel": {
"description": "Contains some information about a VPN tunnel.",
"id": "VpnGatewayStatusTunnel",
"properties": {
"localGatewayInterface": {
"description": "The VPN gateway interface this VPN tunnel is associated with.",
"format": "uint32",
"type": "integer"
},
"peerGatewayInterface": {
"description": "The peer gateway interface this VPN tunnel is connected to, the peer gateway could either be an external VPN gateway or GCP VPN gateway.",
"format": "uint32",
"type": "integer"
},
"tunnelUrl": {
"description": "URL reference to the VPN tunnel.",
"type": "string"
}
},
"type": "object"
},
"VpnGatewayStatusVpnConnection": {
"description": "A VPN connection contains all VPN tunnels connected from this VpnGateway to the same peer gateway. The peer gateway could either be a external VPN gateway or GCP VPN gateway.",
"id": "VpnGatewayStatusVpnConnection",
"properties": {
"peerExternalGateway": {
"description": "URL reference to the peer external VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.",
"type": "string"
},
"peerGcpGateway": {
"description": "URL reference to the peer side VPN gateways to which the VPN tunnels in this VPN connection are connected. This field is mutually exclusive with peer_gcp_gateway.",
"type": "string"
},
"state": {
"$ref": "VpnGatewayStatusHighAvailabilityRequirementState",
"description": "HighAvailabilityRequirementState for the VPN connection."
},
"tunnels": {
"description": "List of VPN tunnels that are in this VPN connection.",
"items": {
"$ref": "VpnGatewayStatusTunnel"
},
"type": "array"
}
},
"type": "object"
},
"VpnGatewayVpnGatewayInterface": {
"description": "A VPN gateway interface.",
"id": "VpnGatewayVpnGatewayInterface",
"properties": {
"id": {
"description": "The numeric ID of this VPN gateway interface.",
"format": "uint32",
"type": "integer"
},
"ipAddress": {
"description": "[Output Only] The external IP address for this VPN gateway interface.",
"type": "string"
}
},
"type": "object"
},
"VpnGatewaysGetStatusResponse": {
"id": "VpnGatewaysGetStatusResponse",
"properties": {
"result": {
"$ref": "VpnGatewayStatus"
}
},
"type": "object"
},
"VpnGatewaysScopedList": {
"id": "VpnGatewaysScopedList",
"properties": {
"vpnGateways": {
"description": "[Output Only] A list of VPN gateways contained in this scope.",
"items": {
"$ref": "VpnGateway"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnTunnel": {
"description": "Represents a Cloud VPN Tunnel resource.\n\nFor more information about VPN, read the the Cloud VPN Overview. (== resource_for {$api_version}.vpnTunnels ==)",
"id": "VpnTunnel",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you create the resource.",
"type": "string"
},
"detailedStatus": {
"description": "[Output Only] Detailed status message for the VPN tunnel.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"ikeVersion": {
"description": "IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2.",
"format": "int32",
"type": "integer"
},
"kind": {
"default": "compute#vpnTunnel",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"type": "string"
},
"localTrafficSelector": {
"description": "Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.vpnTunnels.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"peerExternalGateway": {
"description": "URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway.",
"type": "string"
},
"peerExternalGatewayInterface": {
"description": "The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created.",
"format": "int32",
"type": "integer"
},
"peerGcpGateway": {
"description": "URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway.",
"type": "string"
},
"peerIp": {
"description": "IP address of the peer VPN gateway. Only IPv4 is supported.",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.",
"type": "string"
},
"remoteTrafficSelector": {
"description": "Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported.",
"items": {
"type": "string"
},
"type": "array"
},
"router": {
"description": "URL of the router resource to be used for dynamic routing.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sharedSecret": {
"description": "Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway.",
"type": "string"
},
"sharedSecretHash": {
"description": "Hash of the shared secret.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the VPN tunnel, which can be one of the following: \n- PROVISIONING: Resource is being allocated for the VPN tunnel. \n- WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. \n- FIRST_HANDSHAKE: Successful first handshake with the peer VPN. \n- ESTABLISHED: Secure session is successfully established with the peer VPN. \n- NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS \n- AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). \n- NEGOTIATION_FAILURE: Handshake failed. \n- DEPROVISIONING: Resources are being deallocated for the VPN tunnel. \n- FAILED: Tunnel creation has failed and the tunnel is not ready to be used. \n- NO_INCOMING_PACKETS: No incoming packets from peer. \n- REJECTED: Tunnel configuration was rejected, can be result of being blacklisted. \n- ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. \n- STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. \n- PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. \n- TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel.",
"enum": [
"ALLOCATING_RESOURCES",
"AUTHORIZATION_ERROR",
"DEPROVISIONING",
"ESTABLISHED",
"FAILED",
"FIRST_HANDSHAKE",
"NEGOTIATION_FAILURE",
"NETWORK_ERROR",
"NO_INCOMING_PACKETS",
"PROVISIONING",
"REJECTED",
"STOPPED",
"WAITING_FOR_FULL_CONFIG"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"targetVpnGateway": {
"description": "URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created.",
"type": "string"
},
"vpnGateway": {
"description": "URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created.",
"type": "string"
},
"vpnGatewayInterface": {
"description": "The interface ID of the VPN gateway with which this VPN tunnel is associated.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"VpnTunnelAggregatedList": {
"id": "VpnTunnelAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "VpnTunnelsScopedList",
"description": "Name of the scope containing this set of VPN tunnels."
},
"description": "A list of VpnTunnelsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#vpnTunnelAggregatedList",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnTunnelList": {
"description": "Contains a list of VpnTunnel resources.",
"id": "VpnTunnelList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of VpnTunnel resources.",
"items": {
"$ref": "VpnTunnel"
},
"type": "array"
},
"kind": {
"default": "compute#vpnTunnelList",
"description": "[Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"VpnTunnelsScopedList": {
"id": "VpnTunnelsScopedList",
"properties": {
"vpnTunnels": {
"description": "A list of VPN tunnels contained in this scope.",
"items": {
"$ref": "VpnTunnel"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of addresses when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"WafExpressionSet": {
"id": "WafExpressionSet",
"properties": {
"aliases": {
"description": "A list of alternate IDs. The format should be: - E.g. XSS-stable Generic suffix like \"stable\" is particularly useful if a policy likes to avail newer set of expressions without having to change the policy. A given alias name can't be used for more than one entity set.",
"items": {
"type": "string"
},
"type": "array"
},
"expressions": {
"description": "List of available expressions.",
"items": {
"$ref": "WafExpressionSetExpression"
},
"type": "array"
},
"id": {
"description": "Google specified expression set ID. The format should be: - E.g. XSS-20170329",
"type": "string"
}
},
"type": "object"
},
"WafExpressionSetExpression": {
"id": "WafExpressionSetExpression",
"properties": {
"id": {
"description": "Expression ID should uniquely identify the origin of the expression. E.g. owasp-crs-v020901-id973337 identifies Owasp core rule set version 2.9.1 rule id 973337. The ID could be used to determine the individual attack definition that has been detected. It could also be used to exclude it from the policy in case of false positive.",
"type": "string"
}
},
"type": "object"
},
"WeightedBackendService": {
"description": "In contrast to a single BackendService in HttpRouteAction to which all matching traffic is directed to, WeightedBackendService allows traffic to be split across multiple BackendServices. The volume of traffic for each BackendService is proportional to the weight specified in each WeightedBackendService",
"id": "WeightedBackendService",
"properties": {
"backendService": {
"description": "The full or partial URL to the default BackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect for the selected backendService.\nheaderAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap."
},
"weight": {
"description": "Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) .\nThe selection of a backend service is determined only for new traffic. Once a user's request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService's session affinity policy.\nThe value must be between 0 and 1000",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"XpnHostList": {
"id": "XpnHostList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "[Output Only] A list of shared VPC host project URLs.",
"items": {
"$ref": "Project"
},
"type": "array"
},
"kind": {
"default": "compute#xpnHostList",
"description": "[Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"XpnResourceId": {
"description": "Service resource (a.k.a service project) ID.",
"id": "XpnResourceId",
"properties": {
"id": {
"description": "The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678).",
"type": "string"
},
"type": {
"description": "The type of the service resource.",
"enum": [
"PROJECT",
"XPN_RESOURCE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Zone": {
"description": "Represents a Zone resource.\n\nA zone is a deployment area. These deployment areas are subsets of a region. For example the zone us-east1-a is located in the us-east1 region. For more information, read Regions and Zones. (== resource_for {$api_version}.zones ==)",
"id": "Zone",
"properties": {
"availableCpuPlatforms": {
"description": "[Output Only] Available cpu/platform selections for the zone.",
"items": {
"type": "string"
},
"type": "array"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp in RFC3339 text format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this zone."
},
"description": {
"description": "[Output Only] Textual description of the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#zone",
"description": "[Output Only] Type of the resource. Always compute#zone for zones.",
"type": "string"
},
"name": {
"description": "[Output Only] Name of the resource.",
"type": "string"
},
"region": {
"description": "[Output Only] Full URL reference to the region which hosts the zone.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "[Output Only] Status of the zone, either UP or DOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"ZoneList": {
"description": "Contains a list of zone resources.",
"id": "ZoneList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Zone resources.",
"items": {
"$ref": "Zone"
},
"type": "array"
},
"kind": {
"default": "compute#zoneList",
"description": "Type of resource.",
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.",
"enum": [
"CLEANUP_FAILED",
"DEPRECATED_RESOURCE_USED",
"DEPRECATED_TYPE_USED",
"DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
"EXPERIMENTAL_TYPE_USED",
"EXTERNAL_API_WARNING",
"FIELD_VALUE_OVERRIDEN",
"INJECTED_KERNELS_DEPRECATED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key: value format. For example:\n\"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).",
"type": "string"
},
"value": {
"description": "[Output Only] A warning data value corresponding to the key.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "[Output Only] A human-readable description of the warning code.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"ZoneSetLabelsRequest": {
"id": "ZoneSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels to set for this resource.",
"type": "object"
}
},
"type": "object"
},
"ZoneSetPolicyRequest": {
"id": "ZoneSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backwacd compatible wire-format. Deprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.",
"format": "byte",
"type": "string"
},
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
}
},
"servicePath": "compute/v1/projects/",
"title": "Compute Engine API",
"version": "v1"
}