{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
},
"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 Cloud Storage and see the email address for your Google Account"
},
"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 Cloud Storage and see the email address of your Google Account"
}
}
}
},
"basePath": "/compute/v1/",
"baseUrl": "https://compute.googleapis.com/compute/v1/",
"batchPath": "batch/compute/v1",
"description": "Creates and runs virtual machines on Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/compute/",
"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",
"mtlsRootUrl": "https://compute.mtls.googleapis.com/",
"name": "compute",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"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": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
},
"userIp": {
"description": "Legacy name for parameter that has been superseded by `quotaUser`.",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"acceleratorTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of accelerator types.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/acceleratorTypes",
"httpMethod": "GET",
"id": "compute.acceleratorTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/acceleratorTypes/{acceleratorType}",
"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": "projects/{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 that are available to the specified\nproject.",
"flatPath": "projects/{project}/zones/{zone}/acceleratorTypes",
"httpMethod": "GET",
"id": "compute.acceleratorTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/addresses",
"httpMethod": "GET",
"id": "compute.addresses.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/addresses/{address}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/addresses/{address}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/addresses",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/addresses",
"httpMethod": "GET",
"id": "compute.addresses.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"move": {
"description": "Moves the specified address resource.",
"flatPath": "projects/{project}/regions/{region}/addresses/{address}/move",
"httpMethod": "POST",
"id": "compute.addresses.move",
"parameterOrder": [
"project",
"region",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to move.",
"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": "Source project ID which the Address is moved from.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/addresses/{address}/move",
"request": {
"$ref": "RegionAddressesMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on an Address. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/addresses/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.addresses.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/addresses/{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.",
"flatPath": "projects/{project}/regions/{region}/addresses/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.addresses.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": "projects/{project}/regions/{region}/addresses/{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"
]
}
}
},
"advice": {
"methods": {
"calendarMode": {
"description": "Advise how, where and when to create the requested amount of instances\nwith specified accelerators, within the specified time and location limits.\nThe method recommends creating future reservations for the requested\nresources.",
"flatPath": "projects/{project}/regions/{region}/advice/calendarMode",
"httpMethod": "POST",
"id": "compute.advice.calendarMode",
"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"
}
},
"path": "projects/{project}/regions/{region}/advice/calendarMode",
"request": {
"$ref": "CalendarModeAdviceRequest"
},
"response": {
"$ref": "CalendarModeAdviceResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"autoscalers": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of autoscalers.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/autoscalers",
"httpMethod": "GET",
"id": "compute.autoscalers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers/{autoscaler}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers",
"httpMethod": "GET",
"id": "compute.autoscalers.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.autoscalers.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": "projects/{project}/zones/{zone}/autoscalers/{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 autoscaler in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/zones/{zone}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nbucket.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/addSignedUrlKey",
"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\nadded. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"aggregatedList": {
"description": "Retrieves the list of all BackendBucket resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/backendBuckets",
"httpMethod": "GET",
"id": "compute.backendBuckets.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/backendBuckets",
"response": {
"$ref": "BackendBucketAggregatedList"
},
"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 BackendBucket resource.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nbucket.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/deleteSignedUrlKey",
"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\nadded. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
"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": "projects/{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"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
"flatPath": "projects/{project}/global/backendBuckets/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.backendBuckets.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/backendBuckets/{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 BackendBucket resource in the specified project using\nthe data included in the request.",
"flatPath": "projects/{project}/global/backendBuckets",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/backendBuckets",
"httpMethod": "GET",
"id": "compute.backendBuckets.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"listUsable": {
"description": "Retrieves a list of all usable backend buckets in the specified project.",
"flatPath": "projects/{project}/global/backendBuckets/listUsable",
"httpMethod": "GET",
"id": "compute.backendBuckets.listUsable",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/backendBuckets/listUsable",
"response": {
"$ref": "BackendBucketListUsable"
},
"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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/backendBuckets/{backendBucket}",
"request": {
"$ref": "BackendBucket"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setEdgeSecurityPolicy": {
"description": "Sets the edge security policy for the specified backend bucket.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
"httpMethod": "POST",
"id": "compute.backendBuckets.setEdgeSecurityPolicy",
"parameterOrder": [
"project",
"backendBucket"
],
"parameters": {
"backendBucket": {
"description": "Name of the BackendBucket resource to which the security policy should be\nset. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/backendBuckets/{backendBucket}/setEdgeSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/backendBuckets/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.backendBuckets.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": "projects/{project}/global/backendBuckets/{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.",
"flatPath": "projects/{project}/global/backendBuckets/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.backendBuckets.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": "projects/{project}/global/backendBuckets/{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 the specified BackendBucket resource with the data included in the\nrequest.",
"flatPath": "projects/{project}/global/backendBuckets/{backendBucket}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nservice.",
"flatPath": "projects/{project}/global/backendServices/{backendService}/addSignedUrlKey",
"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\nadded. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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,\navailable to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/backendServices",
"httpMethod": "GET",
"id": "compute.backendServices.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nservice.",
"flatPath": "projects/{project}/global/backendServices/{backendService}/deleteSignedUrlKey",
"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\nadded. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/backendServices/{backendService}",
"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": "projects/{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"
]
},
"getEffectiveSecurityPolicies": {
"description": "Returns effective security policies applied to this backend service.",
"flatPath": "projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies",
"httpMethod": "GET",
"id": "compute.backendServices.getEffectiveSecurityPolicies",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the Backend Service for 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"
}
},
"path": "projects/{project}/global/backendServices/{backendService}/getEffectiveSecurityPolicies",
"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\nBackendService.\n\nExample request body:\n\n{\n  \"group\": \"/zones/us-east1-b/instanceGroups/lb-backend-example\"\n}",
"flatPath": "projects/{project}/global/backendServices/{backendService}/getHealth",
"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": "projects/{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"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
"flatPath": "projects/{project}/global/backendServices/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.backendServices.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/backendServices/{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 BackendService resource in the specified project using\nthe data included in the request. For more information, see\nBackend services overview.",
"flatPath": "projects/{project}/global/backendServices",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/backendServices",
"httpMethod": "GET",
"id": "compute.backendServices.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"listUsable": {
"description": "Retrieves a list of all usable backend services in the specified project.",
"flatPath": "projects/{project}/global/backendServices/listUsable",
"httpMethod": "GET",
"id": "compute.backendServices.listUsable",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/backendServices/listUsable",
"response": {
"$ref": "BackendServiceListUsable"
},
"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\nrequest. For more information, see \nBackend services overview. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setEdgeSecurityPolicy": {
"description": "Sets the edge security policy for the specified backend service.",
"flatPath": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
"httpMethod": "POST",
"id": "compute.backendServices.setEdgeSecurityPolicy",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the edge security policy\nshould 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/backendServices/{backendService}/setEdgeSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.backendServices.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": "projects/{project}/global/backendServices/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSecurityPolicy": {
"description": "Sets the Google Cloud Armor security policy for the specified backend\nservice. For more information, seeGoogle\nCloud Armor Overview",
"flatPath": "projects/{project}/global/backendServices/{backendService}/setSecurityPolicy",
"httpMethod": "POST",
"id": "compute.backendServices.setSecurityPolicy",
"parameterOrder": [
"project",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the security policy should be\nset. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/global/backendServices/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.backendServices.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": "projects/{project}/global/backendServices/{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 the specified BackendService resource with the data included in the\nrequest. For more information, seeBackend\nservices overview.",
"flatPath": "projects/{project}/global/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/backendServices/{backendService}",
"request": {
"$ref": "BackendService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"crossSiteNetworks": {
"methods": {
"delete": {
"description": "Deletes the specified cross-site network in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"httpMethod": "DELETE",
"id": "compute.crossSiteNetworks.delete",
"parameterOrder": [
"project",
"crossSiteNetwork"
],
"parameters": {
"crossSiteNetwork": {
"description": "Name of the cross-site 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified cross-site network in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"httpMethod": "GET",
"id": "compute.crossSiteNetworks.get",
"parameterOrder": [
"project",
"crossSiteNetwork"
],
"parameters": {
"crossSiteNetwork": {
"description": "Name of the cross-site 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": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"response": {
"$ref": "CrossSiteNetwork"
},
"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 cross-site network in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/global/crossSiteNetworks",
"httpMethod": "POST",
"id": "compute.crossSiteNetworks.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "[Input Only] Validate the new configuration, but don't create it.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/crossSiteNetworks",
"request": {
"$ref": "CrossSiteNetwork"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the cross-site networks for a project in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks",
"httpMethod": "GET",
"id": "compute.crossSiteNetworks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/crossSiteNetworks",
"response": {
"$ref": "CrossSiteNetworkList"
},
"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 cross-site network with the data included in\nthe request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"httpMethod": "PATCH",
"id": "compute.crossSiteNetworks.patch",
"parameterOrder": [
"project",
"crossSiteNetwork"
],
"parameters": {
"crossSiteNetwork": {
"description": "Name of the cross-site 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "[Input Only] Validate the new configuration, but don't update it.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}",
"request": {
"$ref": "CrossSiteNetwork"
},
"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.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/diskTypes",
"httpMethod": "GET",
"id": "compute.diskTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/diskTypes/{diskType}",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/zones/{zone}/diskTypes",
"httpMethod": "GET",
"id": "compute.diskTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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\npolicy which will be applied to this disk for scheduling snapshot\ncreation.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/addResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/disks",
"httpMethod": "GET",
"id": "compute.disks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"bulkInsert": {
"description": "Bulk create a set of disks.",
"flatPath": "projects/{project}/zones/{zone}/disks/bulkInsert",
"httpMethod": "POST",
"id": "compute.disks.bulkInsert",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/disks/bulkInsert",
"request": {
"$ref": "BulkInsertDiskResource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"bulkSetLabels": {
"description": "Sets the labels on many disks at once. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/zones/{zone}/disks/bulkSetLabels",
"httpMethod": "POST",
"id": "compute.disks.bulkSetLabels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "query",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"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": "projects/{project}/zones/{zone}/disks/bulkSetLabels",
"request": {
"$ref": "BulkZoneSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"createSnapshot": {
"description": "Creates a snapshot of a specified persistent disk. For regular snapshot\ncreation, consider using snapshots.insert\ninstead, as that method supports more features, such as creating snapshots\nin a project different from the source disk project.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/createSnapshot",
"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] Whether to attempt an application consistent snapshot by\ninforming the OS to prepare for the snapshot process.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\npermanently and is irreversible. However, deleting a disk does not\ndelete any snapshots\npreviously made from the disk. You must separatelydelete\nsnapshots.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
"httpMethod": "DELETE",
"id": "compute.disks.delete",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the persistent disk to delete.",
"location": "path",
"pattern": "\\S{1,66}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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 the specified persistent disk.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/disks/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.disks.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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\nin the request. You can create a disk from a source\n(sourceImage, sourceSnapshot, orsourceDisk) or create an empty 500 GB data disk by\nomitting all properties. You can also create a disk that is larger than\nthe default size by specifying the sizeGb property.",
"flatPath": "projects/{project}/zones/{zone}/disks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceImage": {
"description": "Source image to restore onto a disk. This field is optional.",
"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": "projects/{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\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/disks",
"httpMethod": "GET",
"id": "compute.disks.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/removeResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nYou can only increase the size of the disk.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/resize",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setIamPolicy",
"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": "projects/{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 theLabeling\nResources documentation.",
"flatPath": "projects/{project}/zones/{zone}/disks/{resource}/setLabels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"startAsyncReplication": {
"description": "Starts asynchronous replication.\nMust be invoked on the primary disk.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication",
"httpMethod": "POST",
"id": "compute.disks.startAsyncReplication",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/disks/{disk}/startAsyncReplication",
"request": {
"$ref": "DisksStartAsyncReplicationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopAsyncReplication": {
"description": "Stops asynchronous replication.\nCan be invoked either on the primary or on the secondary disk.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication",
"httpMethod": "POST",
"id": "compute.disks.stopAsyncReplication",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/disks/{disk}/stopAsyncReplication",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopGroupAsyncReplication": {
"description": "Stops asynchronous replication for a consistency group of disks.\nCan be invoked either in the primary or secondary scope.",
"flatPath": "projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication",
"httpMethod": "POST",
"id": "compute.disks.stopGroupAsyncReplication",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request. This must be the zone of the primary\nor secondary disks in the consistency group.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/disks/stopGroupAsyncReplication",
"request": {
"$ref": "DisksStopGroupAsyncReplicationResource"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/disks/{resource}/testIamPermissions",
"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": "projects/{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"
]
},
"update": {
"description": "Updates the specified disk with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}",
"httpMethod": "PATCH",
"id": "compute.disks.update",
"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"
},
"paths": {
"location": "query",
"repeated": 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"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": "projects/{project}/zones/{zone}/disks/{disk}",
"request": {
"$ref": "Disk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateKmsKey": {
"description": "Rotates the customer-managed\nencryption key to the latest version for the specified persistent disk.",
"flatPath": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey",
"httpMethod": "POST",
"id": "compute.disks.updateKmsKey",
"parameterOrder": [
"project",
"zone",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the Disk resource, 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/disks/{disk}/updateKmsKey",
"request": {
"$ref": "DiskUpdateKmsKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"externalVpnGateways": {
"methods": {
"delete": {
"description": "Deletes the specified externalVpnGateway.",
"flatPath": "projects/{project}/global/externalVpnGateways/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nexternalVpnGateways by making a list() request.",
"flatPath": "projects/{project}/global/externalVpnGateways/{externalVpnGateway}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/global/externalVpnGateways",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/externalVpnGateways",
"httpMethod": "GET",
"id": "compute.externalVpnGateways.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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,\nread the Labeling\nResources documentation.",
"flatPath": "projects/{project}/global/externalVpnGateways/{resource}/setLabels",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/externalVpnGateways/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"firewallPolicies": {
"methods": {
"addAssociation": {
"description": "Inserts an association for the specified firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
"httpMethod": "POST",
"id": "compute.firewallPolicies.addAssociation",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"replaceExistingAssociation": {
"description": "Indicates whether or not to replace it if an association of the attachment\nalready exists. This is false by default, in which case an error will be\nreturned if an association already exists.",
"location": "query",
"type": "boolean"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/addAssociation",
"request": {
"$ref": "FirewallPolicyAssociation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addRule": {
"description": "Inserts a rule into a firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
"httpMethod": "POST",
"id": "compute.firewallPolicies.addRule",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/addRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"cloneRules": {
"description": "Copies rules to the specified firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
"httpMethod": "POST",
"id": "compute.firewallPolicies.cloneRules",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceFirewallPolicy": {
"description": "The firewall policy from which to copy rules.",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/cloneRules",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "DELETE",
"id": "compute.firewallPolicies.delete",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to delete.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "GET",
"id": "compute.firewallPolicies.get",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to get.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "FirewallPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getAssociation": {
"description": "Gets an association with the specified name.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
"httpMethod": "GET",
"id": "compute.firewallPolicies.getAssociation",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to which the queried rule belongs.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"name": {
"description": "The name of the association to get from the firewall policy.",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/getAssociation",
"response": {
"$ref": "FirewallPolicyAssociation"
},
"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\npolicy or resource exists.",
"flatPath": "locations/global/firewallPolicies/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.firewallPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{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"
]
},
"getRule": {
"description": "Gets a rule of the specified priority.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
"httpMethod": "GET",
"id": "compute.firewallPolicies.getRule",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to which the queried rule belongs.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"priority": {
"description": "The priority of the rule to get from the firewall policy.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/getRule",
"response": {
"$ref": "FirewallPolicyRule"
},
"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\nthe request.",
"flatPath": "locations/global/firewallPolicies",
"httpMethod": "POST",
"id": "compute.firewallPolicies.insert",
"parameters": {
"parentId": {
"description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\"\nif the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the\nparent is an organization.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all the policies that have been configured for the specified\nfolder or organization.",
"flatPath": "locations/global/firewallPolicies",
"httpMethod": "GET",
"id": "compute.firewallPolicies.list",
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentId": {
"description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\"\nif the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the\nparent is an organization.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "locations/global/firewallPolicies",
"response": {
"$ref": "FirewallPolicyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listAssociations": {
"description": "Lists associations of a specified target, i.e., organization or folder.",
"flatPath": "locations/global/firewallPolicies/listAssociations",
"httpMethod": "GET",
"id": "compute.firewallPolicies.listAssociations",
"parameters": {
"includeInheritedPolicies": {
"description": "If set to \"true\", the response will contain a list of all associations for\nthe containing folders and the containing organization of the target. The\nparameter has no effect if the target is an organization.",
"location": "query",
"type": "boolean"
},
"targetResource": {
"description": "The target resource to list associations. It is an organization, or a\nfolder.",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/listAssociations",
"response": {
"$ref": "FirewallPoliciesListAssociationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"move": {
"description": "Moves the specified firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/move",
"httpMethod": "POST",
"id": "compute.firewallPolicies.move",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"parentId": {
"description": "The new parent of the firewall policy. The ID can be either be\n\"folders/[FOLDER_ID]\" if the parent is a folder or\n\"organizations/[ORGANIZATION_ID]\" if the parent is an organization.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/move",
"response": {
"$ref": "Operation"
},
"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.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "PATCH",
"id": "compute.firewallPolicies.patch",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patchRule": {
"description": "Patches a rule of the specified priority.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule",
"httpMethod": "POST",
"id": "compute.firewallPolicies.patchRule",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"priority": {
"description": "The priority of the rule to patch.",
"format": "int32",
"location": "query",
"type": "integer"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/patchRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeAssociation": {
"description": "Removes an association for the specified firewall policy.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
"httpMethod": "POST",
"id": "compute.firewallPolicies.removeAssociation",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"name": {
"description": "Name for the attachment that will be removed.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/removeAssociation",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeRule": {
"description": "Deletes a rule of the specified priority.",
"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule",
"httpMethod": "POST",
"id": "compute.firewallPolicies.removeRule",
"parameterOrder": [
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to update.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"priority": {
"description": "The priority of the rule to remove from the firewall policy.",
"format": "int32",
"location": "query",
"type": "integer"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{firewallPolicy}/removeRule",
"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.\nReplaces any existing policy.",
"flatPath": "locations/global/firewallPolicies/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.firewallPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{resource}/setIamPolicy",
"request": {
"$ref": "GlobalOrganizationSetPolicyRequest"
},
"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.",
"flatPath": "locations/global/firewallPolicies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.firewallPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "Name or id of the resource for this request.",
"location": "path",
"pattern": "(firewallPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/firewallPolicies/{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.",
"flatPath": "projects/{project}/global/firewalls/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/firewalls/{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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/firewalls",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/firewalls",
"httpMethod": "GET",
"id": "compute.firewalls.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/firewalls/{firewall}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewalls/{firewall}",
"request": {
"$ref": "Firewall"
},
"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.",
"flatPath": "projects/{project}/global/firewalls/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.firewalls.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": "projects/{project}/global/firewalls/{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 the specified firewall rule with the data included in the\nrequest.\nNote that all fields will be updated if using PUT, even fields that are not\nspecified. To update individual fields, please use PATCH instead.",
"flatPath": "projects/{project}/global/firewalls/{firewall}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/forwardingRules",
"httpMethod": "GET",
"id": "compute.forwardingRules.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules",
"httpMethod": "GET",
"id": "compute.forwardingRules.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules. Currently, you can only\npatch the network_tier field.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"setLabels": {
"description": "Sets the labels on the specified resource. To learn more about labels,\nread the \nLabeling Resources documentation.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.forwardingRules.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/forwardingRules/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"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\nsame type as the old target.",
"flatPath": "projects/{project}/regions/{region}/forwardingRules/{forwardingRule}/setTarget",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
}
}
},
"futureReservations": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of future reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/futureReservations",
"httpMethod": "GET",
"id": "compute.futureReservations.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/futureReservations",
"response": {
"$ref": "FutureReservationsAggregatedListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"cancel": {
"description": "Cancel the specified future reservation.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel",
"httpMethod": "POST",
"id": "compute.futureReservations.cancel",
"parameterOrder": [
"project",
"zone",
"futureReservation"
],
"parameters": {
"futureReservation": {
"description": "Name of the future reservation to retrieve. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}/cancel",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified future reservation.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"httpMethod": "DELETE",
"id": "compute.futureReservations.delete",
"parameterOrder": [
"project",
"zone",
"futureReservation"
],
"parameters": {
"futureReservation": {
"description": "Name of the future reservation to retrieve. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves information about the specified future reservation.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"httpMethod": "GET",
"id": "compute.futureReservations.get",
"parameterOrder": [
"project",
"zone",
"futureReservation"
],
"parameters": {
"futureReservation": {
"description": "Name of the future reservation to retrieve. 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"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"response": {
"$ref": "FutureReservation"
},
"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 Future Reservation.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations",
"httpMethod": "POST",
"id": "compute.futureReservations.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations",
"request": {
"$ref": "FutureReservation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "A list of all the future reservations that have been configured for the\nspecified project in specified zone.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations",
"httpMethod": "GET",
"id": "compute.futureReservations.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations",
"response": {
"$ref": "FutureReservationsListResponse"
},
"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 future reservation.",
"flatPath": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"httpMethod": "PATCH",
"id": "compute.futureReservations.update",
"parameterOrder": [
"project",
"zone",
"futureReservation"
],
"parameters": {
"futureReservation": {
"description": "Name of the reservation to update. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/futureReservations/{futureReservation}",
"request": {
"$ref": "FutureReservation"
},
"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.",
"flatPath": "projects/{project}/global/addresses/{address}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/addresses/{address}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/addresses",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/addresses",
"httpMethod": "GET",
"id": "compute.globalAddresses.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"move": {
"description": "Moves the specified address resource from one project to another project.",
"flatPath": "projects/{project}/global/addresses/{address}/move",
"httpMethod": "POST",
"id": "compute.globalAddresses.move",
"parameterOrder": [
"project",
"address"
],
"parameters": {
"address": {
"description": "Name of the address resource to move.",
"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": "Source project ID which the Address is moved from.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/addresses/{address}/move",
"request": {
"$ref": "GlobalAddressesMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on a GlobalAddress. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/global/addresses/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.globalAddresses.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": "projects/{project}/global/addresses/{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.",
"flatPath": "projects/{project}/global/addresses/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.globalAddresses.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": "projects/{project}/global/addresses/{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"
]
}
}
},
"globalForwardingRules": {
"methods": {
"delete": {
"description": "Deletes the specified GlobalForwardingRule resource.",
"flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\navailable forwarding rules by making a list() request.",
"flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/global/forwardingRules",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nspecified project.",
"flatPath": "projects/{project}/global/forwardingRules",
"httpMethod": "GET",
"id": "compute.globalForwardingRules.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules. Currently, you can only\npatch the network_tier field.",
"flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/forwardingRules/{forwardingRule}",
"request": {
"$ref": "ForwardingRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on the specified resource. To learn more about labels,\nread the \nLabeling resources documentation.",
"flatPath": "projects/{project}/global/forwardingRules/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.globalForwardingRules.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": "projects/{project}/global/forwardingRules/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"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\nshould be of the same type as the old target.",
"flatPath": "projects/{project}/global/forwardingRules/{forwardingRule}/setTarget",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.attachNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are attaching network\nendpoints 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\ndeleted if there are backend services referencing it.",
"flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
"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\nRFC1035.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.detachNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are removing network\nendpoints. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}",
"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": "projects/{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\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n   \n   - \n   To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n   NEGs): zonal\n   API\n   - \n   To manage NEGs with regional scope (such as regional internet NEGs,\n   serverless NEGs, Private Service Connect NEGs): regional\n   API\n   - \n   To manage NEGs with global scope (such as global internet NEGs):global\n   API",
"flatPath": "projects/{project}/global/networkEndpointGroups",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nspecified project.",
"flatPath": "projects/{project}/global/networkEndpointGroups",
"httpMethod": "GET",
"id": "compute.globalNetworkEndpointGroups.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.globalNetworkEndpointGroups.listNetworkEndpoints",
"parameterOrder": [
"project",
"networkEndpointGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nlist 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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/operations",
"httpMethod": "GET",
"id": "compute.globalOperations.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/operations/{operation}",
"httpMethod": "DELETE",
"id": "compute.globalOperations.delete",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete, or its unique numeric\nidentifier.",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/operations/{operation}",
"httpMethod": "GET",
"id": "compute.globalOperations.get",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/operations",
"httpMethod": "GET",
"id": "compute.globalOperations.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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`\nor for the request to approach the 2 minute deadline, and retrieves the\nspecified Operation resource. This method differs from the\n`GET` method in that it waits for no more than the default\ndeadline (2 minutes) and then returns the current state of the operation,\nwhich might be `DONE` or still in progress.\n\nThis method is called on a best-effort basis. Specifically:\n   \n   \n    - In uncommon cases, when the server is overloaded, the request might\n    return before the default deadline is reached, or might return after zero\n    seconds.\n   - If the default deadline is reached, there is no guarantee that the\n    operation is actually done when the method returns. Be prepared to retry\n    if the operation is not `DONE`.",
"flatPath": "projects/{project}/global/operations/{operation}/wait",
"httpMethod": "POST",
"id": "compute.globalOperations.wait",
"parameterOrder": [
"project",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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"
]
}
}
},
"globalOrganizationOperations": {
"methods": {
"delete": {
"description": "Deletes the specified Operations resource.",
"flatPath": "locations/global/operations/{operation}",
"httpMethod": "DELETE",
"id": "compute.globalOrganizationOperations.delete",
"parameterOrder": [
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete, or its unique numeric\nidentifier.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"parentId": {
"description": "Parent ID for this request.",
"location": "query",
"type": "string"
}
},
"path": "locations/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\nby making a `list()` request.",
"flatPath": "locations/global/operations/{operation}",
"httpMethod": "GET",
"id": "compute.globalOrganizationOperations.get",
"parameterOrder": [
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return. Parent is derived from this\nfield.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"parentId": {
"description": "Parent ID for this request. Not used. Parent is derived from resource_id.",
"location": "query",
"type": "string"
}
},
"path": "locations/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\norganization.",
"flatPath": "locations/global/operations",
"httpMethod": "GET",
"id": "compute.globalOrganizationOperations.list",
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentId": {
"description": "Parent ID for this request.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "locations/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"
]
}
}
},
"globalPublicDelegatedPrefixes": {
"methods": {
"delete": {
"description": "Deletes the specified global PublicDelegatedPrefix.",
"flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "DELETE",
"id": "compute.globalPublicDelegatedPrefixes.delete",
"parameterOrder": [
"project",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified global PublicDelegatedPrefix resource.",
"flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "GET",
"id": "compute.globalPublicDelegatedPrefixes.get",
"parameterOrder": [
"project",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"response": {
"$ref": "PublicDelegatedPrefix"
},
"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 global PublicDelegatedPrefix in the specified project using the\nparameters that are included in the request.",
"flatPath": "projects/{project}/global/publicDelegatedPrefixes",
"httpMethod": "POST",
"id": "compute.globalPublicDelegatedPrefixes.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicDelegatedPrefixes",
"request": {
"$ref": "PublicDelegatedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the global PublicDelegatedPrefixes for a project.",
"flatPath": "projects/{project}/global/publicDelegatedPrefixes",
"httpMethod": "GET",
"id": "compute.globalPublicDelegatedPrefixes.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/publicDelegatedPrefixes",
"response": {
"$ref": "PublicDelegatedPrefixList"
},
"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 global PublicDelegatedPrefix resource with the data\nincluded in the request. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "PATCH",
"id": "compute.globalPublicDelegatedPrefixes.patch",
"parameterOrder": [
"project",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"request": {
"$ref": "PublicDelegatedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"globalVmExtensionPolicies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all VM Extension Policy resources\navailable to the specified project.\n\nTo prevent failure, it's recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/vmExtensionPolicies",
"httpMethod": "GET",
"id": "compute.globalVmExtensionPolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/vmExtensionPolicies",
"response": {
"$ref": "VmExtensionPolicyAggregatedListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"delete": {
"description": "Purge scoped resources (zonal policies) from a global VM extension\npolicy, and then delete the global VM extension policy. Purge of the scoped\nresources is a pre-condition of the global VM extension policy deletion.\nThe deletion of the global VM extension policy happens after the purge\nrollout is done, so it's not a part of the LRO. It's an automatic process\nthat triggers in the backend.",
"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete",
"httpMethod": "POST",
"id": "compute.globalVmExtensionPolicies.delete",
"parameterOrder": [
"project",
"globalVmExtensionPolicy"
],
"parameters": {
"globalVmExtensionPolicy": {
"description": "Name of the global VM extension policy to purge scoped resources for.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}/delete",
"request": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Gets details of a global VM extension policy.",
"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
"httpMethod": "GET",
"id": "compute.globalVmExtensionPolicies.get",
"parameterOrder": [
"project",
"globalVmExtensionPolicy"
],
"parameters": {
"globalVmExtensionPolicy": {
"description": "Name of the GlobalVmExtensionPolicy 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": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
"response": {
"$ref": "GlobalVmExtensionPolicy"
},
"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 project level GlobalVmExtensionPolicy.",
"flatPath": "projects/{project}/global/vmExtensionPolicies",
"httpMethod": "POST",
"id": "compute.globalVmExtensionPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/vmExtensionPolicies",
"request": {
"$ref": "GlobalVmExtensionPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists global VM extension policies.",
"flatPath": "projects/{project}/global/vmExtensionPolicies",
"httpMethod": "GET",
"id": "compute.globalVmExtensionPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/vmExtensionPolicies",
"response": {
"$ref": "GlobalVmExtensionPolicyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Updates a global VM extension policy.",
"flatPath": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
"httpMethod": "PATCH",
"id": "compute.globalVmExtensionPolicies.update",
"parameterOrder": [
"project",
"globalVmExtensionPolicy"
],
"parameters": {
"globalVmExtensionPolicy": {
"description": "Name of the global VM extension policy to update.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/vmExtensionPolicies/{globalVmExtensionPolicy}",
"request": {
"$ref": "GlobalVmExtensionPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"healthChecks": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all HealthCheck resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/healthChecks",
"httpMethod": "GET",
"id": "compute.healthChecks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/healthChecks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/healthChecks",
"httpMethod": "GET",
"id": "compute.healthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/healthChecks/{healthCheck}",
"request": {
"$ref": "HealthCheck"
},
"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.",
"flatPath": "projects/{project}/global/healthChecks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.healthChecks.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": "projects/{project}/global/healthChecks/{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 a HealthCheck resource in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/global/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/httpHealthChecks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/httpHealthChecks",
"httpMethod": "GET",
"id": "compute.httpHealthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
"request": {
"$ref": "HttpHealthCheck"
},
"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.",
"flatPath": "projects/{project}/global/httpHealthChecks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.httpHealthChecks.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": "projects/{project}/global/httpHealthChecks/{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 a HttpHealthCheck resource in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/global/httpHealthChecks/{httpHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/httpsHealthChecks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/httpsHealthChecks",
"httpMethod": "GET",
"id": "compute.httpsHealthChecks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"request": {
"$ref": "HttpsHealthCheck"
},
"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.",
"flatPath": "projects/{project}/global/httpsHealthChecks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.httpsHealthChecks.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": "projects/{project}/global/httpsHealthChecks/{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 a HttpsHealthCheck resource in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/httpsHealthChecks/{httpsHealthCheck}",
"request": {
"$ref": "HttpsHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"imageFamilyViews": {
"methods": {
"get": {
"description": "Returns the latest image that is part of an image family, is not\ndeprecated and is rolled out in the specified zone.",
"flatPath": "projects/{project}/zones/{zone}/imageFamilyViews/{family}",
"httpMethod": "GET",
"id": "compute.imageFamilyViews.get",
"parameterOrder": [
"project",
"zone",
"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"
},
"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": "projects/{project}/zones/{zone}/imageFamilyViews/{family}",
"response": {
"$ref": "ImageFamilyView"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"images": {
"methods": {
"delete": {
"description": "Deletes the specified image.",
"flatPath": "projects/{project}/global/images/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/images/{image}/deprecate",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/images/{image}",
"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": "projects/{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\ndeprecated. For more information on image families, seePublic\nimage families documentation.",
"flatPath": "projects/{project}/global/images/family/{family}",
"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": "The image project that the image belongs to. For example, to get a CentOS\nimage, specify centos-cloud as the image 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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/images/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.images.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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\nin the request.",
"flatPath": "projects/{project}/global/images",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/images",
"request": {
"$ref": "Image"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of custom images\navailable to the specified project. Custom images are images you\ncreate that belong to your project. This method does not\nget any images that belong to other projects, including publicly-available\nimages, like Debian 8. If you want to get a list of publicly-available\nimages, use this method to make a request to the respective image project,\nsuch as debian-cloud or windows-cloud.",
"flatPath": "projects/{project}/global/images",
"httpMethod": "GET",
"id": "compute.images.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"patch": {
"description": "Patches the specified image with the data included in the request.\nOnly the following fields can be modified: family, description,\ndeprecation status.",
"flatPath": "projects/{project}/global/images/{image}",
"httpMethod": "PATCH",
"id": "compute.images.patch",
"parameterOrder": [
"project",
"image"
],
"parameters": {
"image": {
"description": "Name of the image 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/images/{image}",
"request": {
"$ref": "Image"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/images/{resource}/setIamPolicy",
"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": "projects/{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 theLabeling\nResources documentation.",
"flatPath": "projects/{project}/global/images/{resource}/setLabels",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/images/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"instanceGroupManagerResizeRequests": {
"methods": {
"cancel": {
"description": "Cancels the specified resize request and removes it from the queue.\nCancelled resize request does no longer wait for the resources to be\nprovisioned. Cancel is only possible for requests that are accepted in the\nqueue.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel",
"httpMethod": "POST",
"id": "compute.instanceGroupManagerResizeRequests.cancel",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nThe name should conform to RFC1035 or be a resource ID.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resizeRequest": {
"description": "The name of the resize request to cancel.\nThe name should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified, inactive resize request. Requests that are still\nactive cannot be deleted. Deleting request does not delete instances that\nwere provisioned previously.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"httpMethod": "DELETE",
"id": "compute.instanceGroupManagerResizeRequests.delete",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nThe name should conform to RFC1035 or be a resource ID.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resizeRequest": {
"description": "The name of the resize request to delete.\nThe name should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"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 resize request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"httpMethod": "GET",
"id": "compute.instanceGroupManagerResizeRequests.get",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.",
"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"
},
"resizeRequest": {
"description": "The name of the resize request.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the href=\"/compute/docs/regions-zones/#available\">zone\nscoping this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"response": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"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 resize request that starts provisioning VMs immediately\nor queues VM creation.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"httpMethod": "POST",
"id": "compute.instanceGroupManagerResizeRequests.insert",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group to which the resize request will\nbe added.\nName should conform to RFC1035 or be a resource ID.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located and where the resize request will be created.\nName should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"request": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of resize requests that are contained in the\nmanaged instance group.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"httpMethod": "GET",
"id": "compute.instanceGroupManagerResizeRequests.list",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"response": {
"$ref": "InstanceGroupManagerResizeRequestsListResponse"
},
"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\nmanaged instance group. Abandoning an instance does not delete the\ninstance, but it does remove the instance from any target pools that are\napplied by the managed instance group. This method reduces thetargetSize of the managed instance group by the\nnumber of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have\nnot yet been removed from the group. You must separately verify the\nstatus of the abandoning action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/instanceGroupManagers",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\nThis method can be used to apply new overrides and/or new versions.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
"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 thezone\nwhere the managed instance group is located. Should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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 configurations in this managed instance\ngroup. Instances are created using the current instance template. Thecreate instances operation is marked DONE if thecreateInstances request is successful. The underlying actions\ntake additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/createInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.createInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nin that group. Note that the instance group must not belong to a\nbackend service. Read\nDeleting an instance group for more information.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\ndeletion. The instances are also removed from any target\npools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of\ninstances that you delete. This operation is marked as DONE\nwhen the action is scheduled even if the instances are still being deleted.\nYou must separately verify the status of the deleting action\nwith thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"deletePerInstanceConfigs": {
"description": "Deletes selected per-instance configurations for the managed instance\ngroup.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.deletePerInstanceConfigs",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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 thezone\nwhere the managed instance\ngroup is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
"request": {
"$ref": "InstanceGroupManagersDeletePerInstanceConfigsReq"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"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 thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nin the request. After the group is created, instances in the group are\ncreated using the specified instance template.\nThis operation is marked as DONE when the group is created\neven if the instances in the group have not yet been created. You\nmust separately verify the status of the individual instances with thelistmanagedinstances\nmethod.\n\nA managed instance group can have up to 1000 VM instances per group. Please\ncontact Cloud Support if you need an increase in\nthis limit.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere you want to create the managed instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nspecified project and zone.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\ninstance group. The filter and orderBy query\nparameters are not supported.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listErrors",
"httpMethod": "GET",
"id": "compute.instanceGroupManagers.listErrors",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt must be a string that meets the requirements in RFC1035, or an\nunsigned long integer: must match regexp pattern:\n(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nin the list has a currentAction, which indicates the action\nthat the managed instance group is performing on the instance. For example,\nif the group is still creating an instance, the currentAction\nis CREATING. If a previous action failed, the\nlist displays the errors for that failed action. The orderBy\nquery parameter is not supported. The `pageToken` query parameter is\nsupported only if the group's `listManagedInstancesResults` field is set\nto `PAGINATED`.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.listManagedInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"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.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"listPerInstanceConfigs": {
"description": "Lists all of the per-instance configurations defined for the managed\ninstance group. The orderBy query parameter is not supported.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.listPerInstanceConfigs",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
"response": {
"$ref": "InstanceGroupManagersListPerInstanceConfigsResp"
},
"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\nin the request.\nThis operation is marked as DONE when the group is patched\neven if the instances in the group are still in the process of being\npatched. You must separately verify the status of the individual instances\nwith thelistManagedInstances\nmethod. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.\n\nIf you update your group to specify a new template or instance\nconfiguration, it's possible that your intended specification for each VM\nin the group is different from the current state of that VM. To learn how\nto apply an updated configuration to the VMs in a MIG, seeUpdating instances in\na MIG.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where\nyou want to create the managed instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"patchPerInstanceConfigs": {
"description": "Inserts or patches per-instance configurations for the managed instance\ngroup. perInstanceConfig.name serves as a key used to\ndistinguish whether to perform insert or patch.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.patchPerInstanceConfigs",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
"request": {
"$ref": "InstanceGroupManagersPatchPerInstanceConfigsReq"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"recreateInstances": {
"description": "Flags the specified VM instances in the managed instance group to be\nimmediately recreated. Each instance is recreated using the group's current\nconfiguration. This operation is marked as DONE when the flag\nis set even if the instances have not yet been recreated. You must\nseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking\nthe status of managed instances.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\ncreates new instances using the current instance template. If you decrease\nthe size, the group deletes instances. The resize operation is markedDONE when the resize actions are scheduled even if the group\nhas not yet added or deleted any instances. You must separately\nverify the status of the creating or deleting\nactions with thelistmanagedinstances\nmethod.\n\nWhen resizing down, the instance group arbitrarily chooses the order in\nwhich VMs are deleted. The group takes into account some VM attributes when\nmaking the selection including:\n\n+ The status of the VM instance.\n+ The health of the VM instance.\n+ The instance template version the VM is based on.\n+ 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\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"size": {
"description": "The number of running instances that the managed instance group should\nmaintain at any given time. The group automatically adds or removes\ninstances to maintain the number of instances specified by this parameter.",
"format": "int32",
"location": "query",
"required": true,
"type": "integer"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resize",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resumeInstances": {
"description": "Flags the specified instances in the managed instance group to be\nresumed. This method increases thetargetSize and decreases the targetSuspendedSize\nof the managed instance group by the number of instances that you resume.\nThe resumeInstances operation is marked DONE if\nthe resumeInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances\nmethod.\n\nIn this request, you can only specify instances that are suspended. For\nexample, if an instance was previously suspended using the suspendInstances\nmethod, it can be resumed using the resumeInstances method.\n\nIf a health check is attached to the managed instance group, the specified\ninstances will be verified as healthy after they are resumed.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.resumeInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances",
"request": {
"$ref": "InstanceGroupManagersResumeInstancesRequest"
},
"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\ngroup. The templates for existing instances in the group do not change\nunless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\ngroup are assigned. The target pools automatically apply to all of the\ninstances in the managed instance group. This operation is markedDONE when you make the request even if the instances have not\nyet been added to their target pools. The change might take some time to\napply to all of the instances in the group depending on the size of the\ngroup.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"startInstances": {
"description": "Flags the specified instances in the managed instance group to be\nstarted. This method increases thetargetSize and decreases the targetStoppedSize\nof the managed instance group by the number of instances that you start.\nThe startInstances operation is marked DONE if\nthe startInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances\nmethod.\n\nIn this request, you can only specify instances that are stopped. For\nexample, if an instance was previously stopped using the stopInstances\nmethod, it can be started using the startInstances method.\n\nIf a health check is attached to the managed instance group, the specified\ninstances will be verified as healthy after they are started.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.startInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances",
"request": {
"$ref": "InstanceGroupManagersStartInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopInstances": {
"description": "Flags the specified instances in the managed instance group to be\nimmediately stopped. You can only specify instances that are running in\nthis request. This method reduces thetargetSize and increases the targetStoppedSize\nof the managed instance group by the number of instances that you stop.\nThe stopInstances operation is marked DONE if\nthe stopInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances\nmethod.\n\nIf the standbyPolicy.initialDelaySec field is set, the group\ndelays stopping the instances until initialDelaySec have\npassed from instance.creationTimestamp (that is, when the\ninstance was created). This delay gives your application time to\nset itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there\nwill be zero delay.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is stopped.\n\nStopped instances can be started using the startInstances\nmethod.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.stopInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances",
"request": {
"$ref": "InstanceGroupManagersStopInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"suspendInstances": {
"description": "Flags the specified instances in the managed instance group to be\nimmediately suspended. You can only specify instances that are running in\nthis request. This method reduces thetargetSize and increases the targetSuspendedSize\nof the managed instance group by the number of instances that you suspend.\nThe suspendInstances operation is marked DONE if\nthe suspendInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances\nmethod.\n\nIf the standbyPolicy.initialDelaySec field is set, the group\ndelays suspension of the instances until initialDelaySec have\npassed from instance.creationTimestamp (that is, when the\ninstance was created). This delay gives your application time to\nset itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there\nwill be zero delay.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is suspended.\n\nSuspended instances can be resumed using the resumeInstances\nmethod.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.suspendInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone where the managed\ninstance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances",
"request": {
"$ref": "InstanceGroupManagersSuspendInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updatePerInstanceConfigs": {
"description": "Inserts or updates per-instance configurations for the managed instance\ngroup. perInstanceConfig.name serves as a key used to\ndistinguish whether to perform insert or patch.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.instanceGroupManagers.updatePerInstanceConfigs",
"parameterOrder": [
"project",
"zone",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of thezone\nwhere the managed instance group is located.\nIt should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
"request": {
"$ref": "InstanceGroupManagersUpdatePerInstanceConfigsReq"
},
"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\ninstances in the instance group must be in the same network/subnetwork.\nRead \nAdding instances for more information.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/addInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/instanceGroups",
"httpMethod": "GET",
"id": "compute.instanceGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\ndeleted. Note that instance group must not belong to a backend service.\nRead\nDeleting an instance group for more information.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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 zonal instance group. Get a list of available zonal\ninstance groups by making a list() request.\n\nFor managed instance groups, use theinstanceGroupManagers\nor regionInstanceGroupManagers\nmethods instead.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}",
"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\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nparameters that are included in the request.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere you want to create the instance group.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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 zonal instance group resources contained within the\nspecified zone.\n\nFor managed instance groups, use theinstanceGroupManagers\nor regionInstanceGroupManagers\nmethods instead.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups",
"httpMethod": "GET",
"id": "compute.instanceGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.\nThe orderBy query parameter is not supported.\nThe filter query parameter is supported, but only for\nexpressions that use `eq` (equal) or `ne` (not equal) operators.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/listInstances",
"httpMethod": "POST",
"id": "compute.instanceGroups.listInstances",
"parameterOrder": [
"project",
"zone",
"instanceGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroup": {
"description": "The name of the instance group from which you want to generate a list\nof included instances.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of the zone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nnot delete those instances.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration before the VM instance is removed or deleted.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/removeInstances",
"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\nremoved.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{instanceGroup}/setNamedPorts",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone\nwhere the instance group is located.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/zones/{zone}/instanceGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.instanceGroups.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": "projects/{project}/zones/{zone}/instanceGroups/{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"
]
}
}
},
"instanceSettings": {
"methods": {
"get": {
"description": "Get Instance settings.",
"flatPath": "projects/{project}/zones/{zone}/instanceSettings",
"httpMethod": "GET",
"id": "compute.instanceSettings.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 for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceSettings",
"response": {
"$ref": "InstanceSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patch Instance settings",
"flatPath": "projects/{project}/zones/{zone}/instanceSettings",
"httpMethod": "PATCH",
"id": "compute.instanceSettings.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"zone": {
"description": "The zone scoping this request. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/instanceSettings",
"request": {
"$ref": "InstanceSettings"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"instanceTemplates": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all InstanceTemplates resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/instanceTemplates",
"httpMethod": "GET",
"id": "compute.instanceTemplates.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/instanceTemplates",
"response": {
"$ref": "InstanceTemplateAggregatedList"
},
"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 template. Deleting an instance template is\npermanent and cannot be undone. It is not possible to delete templates\nthat are already in use by a managed instance group.",
"flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/instanceTemplates/{instanceTemplate}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/instanceTemplates/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.instanceTemplates.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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\ndata that is included in the request. If you are creating a new template to\nupdate an existing instance group, your new instance template must use the\nsame network or, if applicable, the same subnetwork as the original\ntemplate.",
"flatPath": "projects/{project}/global/instanceTemplates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe specified project.",
"flatPath": "projects/{project}/global/instanceTemplates",
"httpMethod": "GET",
"id": "compute.instanceTemplates.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/instanceTemplates/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/instanceTemplates/{resource}/testIamPermissions",
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addAccessConfig",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"addNetworkInterface": {
"description": "Adds one dynamic network interface to an active instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface",
"httpMethod": "POST",
"id": "compute.instances.addNetworkInterface",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "The instance name for this request stored as resource_id.\nName should conform to RFC1035 or be an unsigned long integer.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/addNetworkInterface",
"request": {
"$ref": "NetworkInterface"
},
"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\npolicy right now which will be applied to this instance for scheduling live\nmigrations.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/addResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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 an aggregated list of all of the instances in your project\nacross all regions and zones.\n\nThe performance of this method degrades when a filter is specified on a\nproject that has a very large number of instances.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/instances",
"httpMethod": "GET",
"id": "compute.instances.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\ncreate the disk before you can attach it. It is not possible to create\nand attach a disk at the same time. For more information, readAdding a\npersistent disk to your instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/attachDisk",
"httpMethod": "POST",
"id": "compute.instances.attachDisk",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"forceAttach": {
"description": "Whether to force attach the regional disk even if it's currently attached\nto another instance. If you try to force attach a zonal disk to an\ninstance, you will receive an error.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"bulkInsert": {
"description": "Creates multiple instances. Count specifies the number of instances to\ncreate. For more information, seeAbout bulk\ncreation of VMs.",
"flatPath": "projects/{project}/zones/{zone}/instances/bulkInsert",
"httpMethod": "POST",
"id": "compute.instances.bulkInsert",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/bulkInsert",
"request": {
"$ref": "BulkInsertInstanceResource"
},
"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, seeDeleting\nan instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/deleteAccessConfig",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteNetworkInterface": {
"description": "Deletes one dynamic network interface from an active instance.\nInstancesDeleteNetworkInterfaceRequest indicates:\n- instance from which to delete, using project+zone+resource_id fields;\n- dynamic network interface to be deleted, using network_interface_name\nfield;",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface",
"httpMethod": "POST",
"id": "compute.instances.deleteNetworkInterface",
"parameterOrder": [
"project",
"zone",
"instance",
"networkInterfaceName"
],
"parameters": {
"instance": {
"description": "The instance name for this request stored as resource_id.\nName should conform to RFC1035 or be an unsigned long integer.",
"location": "path",
"required": true,
"type": "string"
},
"networkInterfaceName": {
"description": "The name of the dynamic network interface to be deleted from the 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/deleteNetworkInterface",
"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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/detachDisk",
"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\nthe 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
"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": "projects/{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"
]
},
"getEffectiveFirewalls": {
"description": "Returns effective firewalls applied to an interface of the instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls",
"httpMethod": "GET",
"id": "compute.instances.getEffectiveFirewalls",
"parameterOrder": [
"project",
"zone",
"instance",
"networkInterface"
],
"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"
},
"networkInterface": {
"description": "The name of the network interface to get the effective firewalls.",
"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"
},
"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": "projects/{project}/zones/{zone}/instances/{instance}/getEffectiveFirewalls",
"response": {
"$ref": "InstancesGetEffectiveFirewallsResponse"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getGuestAttributes",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/instances/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.instances.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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"
]
},
"getScreenshot": {
"description": "Returns the screenshot from the specified instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
"httpMethod": "GET",
"id": "compute.instances.getScreenshot",
"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": "projects/{project}/zones/{zone}/instances/{instance}/screenshot",
"response": {
"$ref": "Screenshot"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/serialPort",
"httpMethod": "GET",
"id": "compute.instances.getSerialPortOutput",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance 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"
},
"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": "Specifies the starting byte position of the output to return. To start with\nthe first byte of output to the specified port, omit this field or set it\nto `0`.\n\nIf the output for that byte position is available, this field matches the\n`start` parameter sent with the request. If the amount of serial console\noutput exceeds the size of the buffer (1 MB), the oldest output is\ndiscarded and is no longer available. If the requested start position\nrefers to discarded output, the start position is adjusted to the oldest\noutput still available, and the adjusted start position is returned as the\n`start` property value.\n\nYou can also provide a negative start position, which translates to the\nmost recent number of bytes written to the serial port. For example, -3 is\ninterpreted as the most recent 3 bytes written to the serial console. Note\nthat the negative start is bounded by the retained buffer size, and the\nreturned serial console output will not exceed the max buffer size.",
"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": "projects/{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",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/getShieldedInstanceIdentity",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/zones/{zone}/instances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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\nfollowing are all valid URLs to an instance template:\n   \n   \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"
},
"sourceMachineImage": {
"description": "Specifies the machine image to use to create the instance.\n\nThis field is optional. It can be a full or partial URL. For example, the\nfollowing are all valid URLs to a machine image:\n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/global/global/machineImages/machineImage\n      - projects/project/global/global/machineImages/machineImage\n      - global/machineImages/machineImage",
"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": "projects/{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\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instances",
"httpMethod": "GET",
"id": "compute.instances.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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 a list of resources that refer to the VM instance specified in\nthe request. For example, if the VM instance is part of a managed or\nunmanaged instance group, the referrers list includes the instance group.\nFor more information, readViewing\nreferrers to VM instances.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/referrers",
"httpMethod": "GET",
"id": "compute.instances.listReferrers",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instance": {
"description": "Name of the target instance scoping this request, or '-' if the\nrequest 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.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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"
]
},
"performMaintenance": {
"description": "Perform a manual maintenance on the instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
"httpMethod": "POST",
"id": "compute.instances.performMaintenance",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeResourcePolicies": {
"description": "Removes resource policies from an instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"reportHostAsFaulty": {
"description": "Mark the host as faulty and try to restart the instance on a new host.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
"httpMethod": "POST",
"id": "compute.instances.reportHostAsFaulty",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
"request": {
"$ref": "InstancesReportHostAsFaultyRequest"
},
"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\ndoes not do a graceful shutdown. For more information, seeResetting\nan instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/reset",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resume": {
"description": "Resumes an instance that was suspended using theinstances().suspend\nmethod.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume",
"httpMethod": "POST",
"id": "compute.instances.resume",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the instance resource to resume.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/resume",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"sendDiagnosticInterrupt": {
"description": "Sends diagnostic interrupt to the instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
"httpMethod": "POST",
"id": "compute.instances.sendDiagnosticInterrupt",
"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": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setDeletionProtection": {
"description": "Sets deletion protection on the instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
"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\non 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
"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": "projects/{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 theLabeling\nResources documentation.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nvalues specified in the request.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\ntype specified in the request.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nin the request.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nThis method can only\nbe called on a stopped instance. For more information, readSpecifying a\nMinimum CPU Platform.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"setName": {
"description": "Sets name of an instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setName",
"httpMethod": "POST",
"id": "compute.instances.setName",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/setName",
"request": {
"$ref": "InstancesSetNameRequest"
},
"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. You can only call this method on astopped instance,\nthat is, a VM instance that is in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.\nFor more information about setting scheduling options for a VM, seeSet\nVM host maintenance policy.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"setSecurityPolicy": {
"description": "Sets the Google Cloud Armor security policy for the specified instance.\nFor more information, seeGoogle\nCloud Armor Overview",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
"httpMethod": "POST",
"id": "compute.instances.setSecurityPolicy",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"instance": {
"description": "Name of the Instance resource to which the security policy should be\nset. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
"request": {
"$ref": "InstancesSetSecurityPolicyRequest"
},
"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,\nreadChanging\nthe service account and access scopes for an instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nonly use this method on a running instance. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nfor the specified instance to the data included in the request.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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 host maintenance event on a VM. For more information, see\nSimulate a host maintenance event.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"withExtendedNotifications": {
"description": "Determines whether the customers receive notifications before migration.\nOnly applicable to SF vms.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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 theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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 theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nyou to restart the instance at a later time. Stopped instances do not incur\nVM usage charges while they are stopped. However, resources that the VM is\nusing, such as persistent disks and static IP addresses, will continue to\nbe charged until they are deleted. For more information, seeStopping\nan instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop",
"httpMethod": "POST",
"id": "compute.instances.stop",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"discardLocalSsd": {
"description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
"location": "query",
"type": "boolean"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/stop",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"suspend": {
"description": "This method suspends a running instance, saving its state to persistent\nstorage, and allows you to resume the instance at a later time. Suspended\ninstances have no compute costs (cores or RAM), and incur only storage\ncharges for the saved VM memory and localSSD data. Any charged resources\nthe virtual machine was using, such as persistent disks and static IP\naddresses, will continue to be charged while the instance is suspended.\nFor more information, see\nSuspending and resuming an instance.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
"httpMethod": "POST",
"id": "compute.instances.suspend",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"discardLocalSsd": {
"description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
"location": "query",
"type": "boolean"
},
"instance": {
"description": "Name of the instance resource to suspend.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
"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.",
"flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
"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": "projects/{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\nmethod can update only a specific set of instance properties. See\nUpdating a running instance for a list of updatable instance\nproperties.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
"httpMethod": "PUT",
"id": "compute.instances.update",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
"discardLocalSsd": {
"description": "Whether to discard local SSDs from the instance during restart\ndefault value is false.",
"location": "query",
"type": "boolean"
},
"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\nupdated properties do not require it. If not specified, then\nCompute Engine acts based on the minimum action that the updated\nproperties require.",
"enum": [
"INVALID",
"NO_EFFECT",
"REFRESH",
"RESTART"
],
"enumDescriptions": [
"",
"No changes can be made to the instance.",
"The instance will not restart.",
"The instance will restart, potentially on a different host."
],
"location": "query",
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "Specifies the most disruptive action that can be taken on the instance\nas part of the update. Compute Engine returns an error if the\ninstance properties require a more disruptive action as part of the\ninstance update. Valid options from lowest to highest are\nNO_EFFECT, REFRESH, and RESTART.",
"enum": [
"INVALID",
"NO_EFFECT",
"REFRESH",
"RESTART"
],
"enumDescriptions": [
"",
"No changes can be made to the instance.",
"The instance will not restart.",
"The instance will restart, potentially on a different host."
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nonly use this method on a stopped VM instance. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateDisplayDevice",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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 can only update an\ninterface's alias IP range and attached network. See Modifying\nalias IP ranges for an existing instance for instructions on\nchanging alias IP ranges. See Migrating\na VM between networks for instructions on migrating an interface.\nThis method follows PATCH semantics.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateNetworkInterface",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nonly use this method on a stopped instance. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateShieldedInstanceConfig",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
}
}
},
"instantSnapshotGroups": {
"methods": {
"delete": {
"description": "deletes a Zonal InstantSnapshotGroup resource",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}",
"httpMethod": "DELETE",
"id": "compute.instantSnapshotGroups.delete",
"parameterOrder": [
"project",
"zone",
"instantSnapshotGroup"
],
"parameters": {
"instantSnapshotGroup": {
"description": "Name of the InstantSnapshot 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "returns the specified InstantSnapshotGroup resource in the specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}",
"httpMethod": "GET",
"id": "compute.instantSnapshotGroups.get",
"parameterOrder": [
"project",
"zone",
"instantSnapshotGroup"
],
"parameters": {
"instantSnapshotGroup": {
"description": "Name of the InstantSnapshotGroup 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": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}",
"response": {
"$ref": "InstantSnapshotGroup"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.instantSnapshotGroups.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/zones/{zone}/instantSnapshotGroups/{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": "inserts a Zonal InstantSnapshotGroup resource",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups",
"httpMethod": "POST",
"id": "compute.instantSnapshotGroups.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceConsistencyGroup": {
"description": "begin_interface: MixerMutationRequestBuilder",
"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": "projects/{project}/zones/{zone}/instantSnapshotGroups",
"request": {
"$ref": "InstantSnapshotGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "retrieves the list of InstantSnapshotGroup resources contained within\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups",
"httpMethod": "GET",
"id": "compute.instantSnapshotGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{project}/zones/{zone}/instantSnapshotGroups",
"response": {
"$ref": "ListInstantSnapshotGroups"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.instantSnapshotGroups.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": "projects/{project}/zones/{zone}/instantSnapshotGroups/{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.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.instantSnapshotGroups.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": "projects/{project}/zones/{zone}/instantSnapshotGroups/{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"
]
}
}
},
"instantSnapshots": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of instantSnapshots.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/instantSnapshots",
"httpMethod": "GET",
"id": "compute.instantSnapshots.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/instantSnapshots",
"response": {
"$ref": "InstantSnapshotAggregatedList"
},
"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 InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}",
"httpMethod": "DELETE",
"id": "compute.instantSnapshots.delete",
"parameterOrder": [
"project",
"zone",
"instantSnapshot"
],
"parameters": {
"instantSnapshot": {
"description": "Name of the InstantSnapshot 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified InstantSnapshot resource in the specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}",
"httpMethod": "GET",
"id": "compute.instantSnapshots.get",
"parameterOrder": [
"project",
"zone",
"instantSnapshot"
],
"parameters": {
"instantSnapshot": {
"description": "Name of the InstantSnapshot 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": "projects/{project}/zones/{zone}/instantSnapshots/{instantSnapshot}",
"response": {
"$ref": "InstantSnapshot"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.instantSnapshots.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/zones/{zone}/instantSnapshots/{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 instant snapshot in the specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots",
"httpMethod": "POST",
"id": "compute.instantSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instantSnapshots",
"request": {
"$ref": "InstantSnapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots",
"httpMethod": "GET",
"id": "compute.instantSnapshots.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{project}/zones/{zone}/instantSnapshots",
"response": {
"$ref": "InstantSnapshotList"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.instantSnapshots.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": "projects/{project}/zones/{zone}/instantSnapshots/{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 instantSnapshot in the given zone. To learn more about\nlabels, read the Labeling\nResources documentation.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.instantSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/instantSnapshots/{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.",
"flatPath": "projects/{project}/zones/{zone}/instantSnapshots/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.instantSnapshots.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": "projects/{project}/zones/{zone}/instantSnapshots/{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"
]
}
}
},
"interconnectAttachmentGroups": {
"methods": {
"delete": {
"description": "Deletes the specified InterconnectAttachmentGroup in the given scope",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"httpMethod": "DELETE",
"id": "compute.interconnectAttachmentGroups.delete",
"parameterOrder": [
"project",
"interconnectAttachmentGroup"
],
"parameters": {
"interconnectAttachmentGroup": {
"description": "Name of the InterconnectAttachmentGroup 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified InterconnectAttachmentGroup resource in the given\nscope.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"httpMethod": "GET",
"id": "compute.interconnectAttachmentGroups.get",
"parameterOrder": [
"project",
"interconnectAttachmentGroup"
],
"parameters": {
"interconnectAttachmentGroup": {
"description": "Name of the InterconnectAttachmentGroup 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": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"response": {
"$ref": "InterconnectAttachmentGroup"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.interconnectAttachmentGroups.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/interconnectAttachmentGroups/{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"
]
},
"getOperationalStatus": {
"description": "Returns the InterconnectAttachmentStatuses for the specified\nInterconnectAttachmentGroup resource.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus",
"httpMethod": "GET",
"id": "compute.interconnectAttachmentGroups.getOperationalStatus",
"parameterOrder": [
"project",
"interconnectAttachmentGroup"
],
"parameters": {
"interconnectAttachmentGroup": {
"description": "Name of the interconnectAttachmentGroup 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": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}/getOperationalStatus",
"response": {
"$ref": "InterconnectAttachmentGroupsGetOperationalStatusResponse"
},
"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 InterconnectAttachmentGroup in the specified project in the given\nscope using the parameters that are included in the request.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups",
"httpMethod": "POST",
"id": "compute.interconnectAttachmentGroups.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectAttachmentGroups",
"request": {
"$ref": "InterconnectAttachmentGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the InterconnectAttachmentGroups for a project in the given scope.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups",
"httpMethod": "GET",
"id": "compute.interconnectAttachmentGroups.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/interconnectAttachmentGroups",
"response": {
"$ref": "InterconnectAttachmentGroupsListResponse"
},
"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 InterconnectAttachmentGroup resource with the data\nincluded in the request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"httpMethod": "PATCH",
"id": "compute.interconnectAttachmentGroups.patch",
"parameterOrder": [
"project",
"interconnectAttachmentGroup"
],
"parameters": {
"interconnectAttachmentGroup": {
"description": "Name of the InterconnectAttachmentGroup 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectAttachmentGroups/{interconnectAttachmentGroup}",
"request": {
"$ref": "InterconnectAttachmentGroup"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.interconnectAttachmentGroups.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": "projects/{project}/global/interconnectAttachmentGroups/{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.",
"flatPath": "projects/{project}/global/interconnectAttachmentGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.interconnectAttachmentGroups.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": "projects/{project}/global/interconnectAttachmentGroups/{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"
]
}
}
},
"interconnectAttachments": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of interconnect attachments.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/interconnectAttachments",
"httpMethod": "GET",
"id": "compute.interconnectAttachments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments",
"httpMethod": "GET",
"id": "compute.interconnectAttachments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{interconnectAttachment}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"setLabels": {
"description": "Sets the labels on an InterconnectAttachment. To learn more about labels,\nread the Labeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.interconnectAttachments.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/interconnectAttachments/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"interconnectGroups": {
"methods": {
"createMembers": {
"description": "Create Interconnects with redundancy by creating them in a specified\ninterconnect group.",
"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers",
"httpMethod": "POST",
"id": "compute.interconnectGroups.createMembers",
"parameterOrder": [
"project",
"interconnectGroup"
],
"parameters": {
"interconnectGroup": {
"description": "Name of the group resource to create members 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": "projects/{project}/global/interconnectGroups/{interconnectGroup}/createMembers",
"request": {
"$ref": "InterconnectGroupsCreateMembersRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified InterconnectGroup in the given scope",
"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"httpMethod": "DELETE",
"id": "compute.interconnectGroups.delete",
"parameterOrder": [
"project",
"interconnectGroup"
],
"parameters": {
"interconnectGroup": {
"description": "Name of the InterconnectGroup 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified InterconnectGroup resource in the given scope.",
"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"httpMethod": "GET",
"id": "compute.interconnectGroups.get",
"parameterOrder": [
"project",
"interconnectGroup"
],
"parameters": {
"interconnectGroup": {
"description": "Name of the InterconnectGroup 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": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"response": {
"$ref": "InterconnectGroup"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/interconnectGroups/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.interconnectGroups.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/interconnectGroups/{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"
]
},
"getOperationalStatus": {
"description": "Returns the interconnectStatuses for the specified\nInterconnectGroup.",
"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus",
"httpMethod": "GET",
"id": "compute.interconnectGroups.getOperationalStatus",
"parameterOrder": [
"project",
"interconnectGroup"
],
"parameters": {
"interconnectGroup": {
"description": "Name of the interconnectGroup 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": "projects/{project}/global/interconnectGroups/{interconnectGroup}/getOperationalStatus",
"response": {
"$ref": "InterconnectGroupsGetOperationalStatusResponse"
},
"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 InterconnectGroup in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/global/interconnectGroups",
"httpMethod": "POST",
"id": "compute.interconnectGroups.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectGroups",
"request": {
"$ref": "InterconnectGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the InterconnectGroups for a project in the given scope.",
"flatPath": "projects/{project}/global/interconnectGroups",
"httpMethod": "GET",
"id": "compute.interconnectGroups.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/interconnectGroups",
"response": {
"$ref": "InterconnectGroupsListResponse"
},
"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 InterconnectGroup resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"httpMethod": "PATCH",
"id": "compute.interconnectGroups.patch",
"parameterOrder": [
"project",
"interconnectGroup"
],
"parameters": {
"interconnectGroup": {
"description": "Name of the InterconnectGroup 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "The list of fields to update.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnectGroups/{interconnectGroup}",
"request": {
"$ref": "InterconnectGroup"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/interconnectGroups/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.interconnectGroups.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": "projects/{project}/global/interconnectGroups/{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.",
"flatPath": "projects/{project}/global/interconnectGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.interconnectGroups.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": "projects/{project}/global/interconnectGroups/{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"
]
}
}
},
"interconnectLocations": {
"methods": {
"get": {
"description": "Returns the details for the specified interconnect location. Gets a list of\navailable interconnect locations by making a list() request.",
"flatPath": "projects/{project}/global/interconnectLocations/{interconnectLocation}",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/interconnectLocations",
"httpMethod": "GET",
"id": "compute.interconnectLocations.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
}
}
},
"interconnectRemoteLocations": {
"methods": {
"get": {
"description": "Returns the details for the specified interconnect remote location. Gets a\nlist of available interconnect remote locations by making alist() request.",
"flatPath": "projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}",
"httpMethod": "GET",
"id": "compute.interconnectRemoteLocations.get",
"parameterOrder": [
"project",
"interconnectRemoteLocation"
],
"parameters": {
"interconnectRemoteLocation": {
"description": "Name of the interconnect remote 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": "projects/{project}/global/interconnectRemoteLocations/{interconnectRemoteLocation}",
"response": {
"$ref": "InterconnectRemoteLocation"
},
"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 remote locations available to the\nspecified project.",
"flatPath": "projects/{project}/global/interconnectRemoteLocations",
"httpMethod": "GET",
"id": "compute.interconnectRemoteLocations.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/interconnectRemoteLocations",
"response": {
"$ref": "InterconnectRemoteLocationList"
},
"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.",
"flatPath": "projects/{project}/global/interconnects/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nby making a list() request.",
"flatPath": "projects/{project}/global/interconnects/{interconnect}",
"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": "projects/{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\nInterconnect.\n\nIn the event of a\nglobal outage, do not use this API to make decisions about where to\nredirect your network traffic.\n\nUnlike a VLAN attachment, which is regional, a Cloud Interconnect\nconnection is a global resource. A global outage can prevent this\nAPI from functioning properly.",
"flatPath": "projects/{project}/global/interconnects/{interconnect}/getDiagnostics",
"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": "projects/{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"
]
},
"getMacsecConfig": {
"description": "Returns the interconnectMacsecConfig for the specified\nInterconnect.",
"flatPath": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig",
"httpMethod": "GET",
"id": "compute.interconnects.getMacsecConfig",
"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": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig",
"response": {
"$ref": "InterconnectsGetMacsecConfigResponse"
},
"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 Interconnect in the specified project using\nthe data included in the request.",
"flatPath": "projects/{project}/global/interconnects",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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 Interconnects available to the specified project.",
"flatPath": "projects/{project}/global/interconnects",
"httpMethod": "GET",
"id": "compute.interconnects.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nThis method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/interconnects/{interconnect}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/interconnects/{interconnect}",
"request": {
"$ref": "Interconnect"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on an Interconnect. To learn more about labels,\nread the Labeling\nResources documentation.",
"flatPath": "projects/{project}/global/interconnects/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.interconnects.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": "projects/{project}/global/interconnects/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"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\nall projects that have permissions to read the License Code.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenseCodes/{licenseCode}",
"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": "projects/{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"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenseCodes/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.licenseCodes.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/licenseCodes/{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"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenseCodes/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.licenseCodes.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": "projects/{project}/global/licenseCodes/{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.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenseCodes/{resource}/testIamPermissions",
"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": "projects/{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.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{license}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{license}",
"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": "projects/{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\npolicy or resource exists.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.licenses.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\navailable in the specified project. This method does not\nget any licenses that belong to other projects, including licenses attached\nto publicly-available images, like Debian 9. If you want to get a list of\npublicly-available licenses, use this method to make a request to the\nrespective image project, such as debian-cloud orwindows-cloud.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses",
"httpMethod": "GET",
"id": "compute.licenses.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nReplaces any existing policy.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{resource}/setIamPolicy",
"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": "projects/{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.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{resource}/testIamPermissions",
"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": "projects/{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"
]
},
"update": {
"description": "Updates a License resource in the specified project.\n *Caution* This resource is intended\nfor use only by third-party partners who are creatingCloud Marketplace\nimages.",
"flatPath": "projects/{project}/global/licenses/{license}",
"httpMethod": "PATCH",
"id": "compute.licenses.update",
"parameterOrder": [
"project",
"license"
],
"parameters": {
"license": {
"description": "The license 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/licenses/{license}",
"request": {
"$ref": "License"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"machineImages": {
"methods": {
"delete": {
"description": "Deletes the specified machine image. Deleting a machine image is permanent\nand cannot be undone.",
"flatPath": "projects/{project}/global/machineImages/{machineImage}",
"httpMethod": "DELETE",
"id": "compute.machineImages.delete",
"parameterOrder": [
"project",
"machineImage"
],
"parameters": {
"machineImage": {
"description": "The name of the machine image 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/machineImages/{machineImage}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified machine image.",
"flatPath": "projects/{project}/global/machineImages/{machineImage}",
"httpMethod": "GET",
"id": "compute.machineImages.get",
"parameterOrder": [
"project",
"machineImage"
],
"parameters": {
"machineImage": {
"description": "The name of the machine image.",
"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": "projects/{project}/global/machineImages/{machineImage}",
"response": {
"$ref": "MachineImage"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/machineImages/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.machineImages.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/machineImages/{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 machine image in the specified project using the\ndata that is included in the request. If you are creating a new machine\nimage to update an existing instance, your new machine image should use the\nsame network or, if applicable, the same subnetwork as the original\ninstance.",
"flatPath": "projects/{project}/global/machineImages",
"httpMethod": "POST",
"id": "compute.machineImages.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceInstance": {
"description": "Required. Source instance that is used to create the machine image from.",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/machineImages",
"request": {
"$ref": "MachineImage"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of machine images that are contained within\nthe specified project.",
"flatPath": "projects/{project}/global/machineImages",
"httpMethod": "GET",
"id": "compute.machineImages.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/machineImages",
"response": {
"$ref": "MachineImageList"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/machineImages/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.machineImages.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": "projects/{project}/global/machineImages/{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 machine image. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/global/machineImages/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.machineImages.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": "projects/{project}/global/machineImages/{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.",
"flatPath": "projects/{project}/global/machineImages/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.machineImages.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": "projects/{project}/global/machineImages/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/machineTypes",
"httpMethod": "GET",
"id": "compute.machineTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/machineTypes/{machineType}",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/zones/{zone}/machineTypes",
"httpMethod": "GET",
"id": "compute.machineTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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"
]
}
}
},
"networkAttachments": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all NetworkAttachment resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/networkAttachments",
"httpMethod": "GET",
"id": "compute.networkAttachments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/networkAttachments",
"response": {
"$ref": "NetworkAttachmentAggregatedList"
},
"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 NetworkAttachment in the given scope",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"httpMethod": "DELETE",
"id": "compute.networkAttachments.delete",
"parameterOrder": [
"project",
"region",
"networkAttachment"
],
"parameters": {
"networkAttachment": {
"description": "Name of the NetworkAttachment 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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified NetworkAttachment resource in the given scope.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"httpMethod": "GET",
"id": "compute.networkAttachments.get",
"parameterOrder": [
"project",
"region",
"networkAttachment"
],
"parameters": {
"networkAttachment": {
"description": "Name of the NetworkAttachment 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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"response": {
"$ref": "NetworkAttachment"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.networkAttachments.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/networkAttachments/{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 NetworkAttachment in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments",
"httpMethod": "POST",
"id": "compute.networkAttachments.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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkAttachments",
"request": {
"$ref": "NetworkAttachment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the NetworkAttachments for a project in the given scope.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments",
"httpMethod": "GET",
"id": "compute.networkAttachments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/networkAttachments",
"response": {
"$ref": "NetworkAttachmentList"
},
"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 NetworkAttachment resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"httpMethod": "PATCH",
"id": "compute.networkAttachments.patch",
"parameterOrder": [
"project",
"region",
"networkAttachment"
],
"parameters": {
"networkAttachment": {
"description": "Name of the NetworkAttachment 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkAttachments/{networkAttachment}",
"request": {
"$ref": "NetworkAttachment"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.networkAttachments.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": "projects/{project}/regions/{region}/networkAttachments/{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.",
"flatPath": "projects/{project}/regions/{region}/networkAttachments/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.networkAttachments.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": "projects/{project}/regions/{region}/networkAttachments/{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"
]
}
}
},
"networkEdgeSecurityServices": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all NetworkEdgeSecurityService resources available to\nthe specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/networkEdgeSecurityServices",
"httpMethod": "GET",
"id": "compute.networkEdgeSecurityServices.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/networkEdgeSecurityServices",
"response": {
"$ref": "NetworkEdgeSecurityServiceAggregatedList"
},
"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 service.",
"flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"httpMethod": "DELETE",
"id": "compute.networkEdgeSecurityServices.delete",
"parameterOrder": [
"project",
"region",
"networkEdgeSecurityService"
],
"parameters": {
"networkEdgeSecurityService": {
"description": "Name of the network edge security service 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Gets a specified NetworkEdgeSecurityService.",
"flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"httpMethod": "GET",
"id": "compute.networkEdgeSecurityServices.get",
"parameterOrder": [
"project",
"region",
"networkEdgeSecurityService"
],
"parameters": {
"networkEdgeSecurityService": {
"description": "Name of the network edge security service 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"response": {
"$ref": "NetworkEdgeSecurityService"
},
"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 service in the specified project using the data included in\nthe request.",
"flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
"httpMethod": "POST",
"id": "compute.networkEdgeSecurityServices.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/networkEdgeSecurityServices",
"request": {
"$ref": "NetworkEdgeSecurityService"
},
"response": {
"$ref": "Operation"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"httpMethod": "PATCH",
"id": "compute.networkEdgeSecurityServices.patch",
"parameterOrder": [
"project",
"region",
"networkEdgeSecurityService"
],
"parameters": {
"networkEdgeSecurityService": {
"description": "Name of the network edge security service 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"
},
"paths": {
"location": "query",
"repeated": 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkEdgeSecurityServices/{networkEdgeSecurityService}",
"request": {
"$ref": "NetworkEdgeSecurityService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"networkEndpointGroups": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of network endpoint groups and sorts them by zone.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/networkEndpointGroups",
"httpMethod": "GET",
"id": "compute.networkEndpointGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"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\nendpoints 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nNEG and the VM instances they belong to are not terminated when the NEG is\ndeleted. Note that the NEG cannot be deleted if there are backend services\nreferencing it.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
"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\nRFC1035.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\ngroup.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"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\nendpoints. 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}",
"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\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n   \n   - \n   To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n   NEGs): zonal\n   API\n   - \n   To manage NEGs with regional scope (such as regional internet NEGs,\n   serverless NEGs, Private Service Connect NEGs): regional\n   API\n   - \n   To manage NEGs with global scope (such as global internet NEGs):global\n   API",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone where\nyou want to create the network endpoint group. It should comply with\nRFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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\nspecified project and zone.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups",
"httpMethod": "GET",
"id": "compute.networkEndpointGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of thezone\nwhere the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.networkEndpointGroups.listNetworkEndpoints",
"parameterOrder": [
"project",
"zone",
"networkEndpointGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nlist 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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of the zone where\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/networkEndpointGroups/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"networkFirewallPolicies": {
"methods": {
"addAssociation": {
"description": "Inserts an association for the specified firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.addAssociation",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
"required": true,
"type": "string"
},
"replaceExistingAssociation": {
"description": "Indicates whether or not to replace it if an association of the attachment\nalready exists. This is false by default, in which case an error will be\nreturned if an association already exists.",
"location": "query",
"type": "boolean"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addAssociation",
"request": {
"$ref": "FirewallPolicyAssociation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addPacketMirroringRule": {
"description": "Inserts a packet mirroring rule into a firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.addPacketMirroringRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"maxPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"format": "int32",
"location": "query",
"type": "integer"
},
"minPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addRule": {
"description": "Inserts a rule into a firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.addRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"maxPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"format": "int32",
"location": "query",
"type": "integer"
},
"minPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"aggregatedList": {
"description": "Retrieves an aggregated list of network firewall policies, listing network\nfirewall policies from all applicable scopes (global and regional) and\ngrouping the results per scope.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/firewallPolicies",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/firewallPolicies",
"response": {
"$ref": "NetworkFirewallPolicyAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"cloneRules": {
"description": "Copies rules to the specified firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.cloneRules",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceFirewallPolicy": {
"description": "The firewall policy from which to copy rules.",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/cloneRules",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "DELETE",
"id": "compute.networkFirewallPolicies.delete",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified network firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.get",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "FirewallPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getAssociation": {
"description": "Gets an association with the specified name.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.getAssociation",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to which the queried association belongs.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"name": {
"description": "The name of the association to get from the firewall policy.",
"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": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getAssociation",
"response": {
"$ref": "FirewallPolicyAssociation"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/firewallPolicies/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/global/firewallPolicies/{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"
]
},
"getPacketMirroringRule": {
"description": "Gets a packet mirroring rule of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.getPacketMirroringRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to get from the firewall 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"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule",
"response": {
"$ref": "FirewallPolicyRule"
},
"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 of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.getRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to get from the firewall 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"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule",
"response": {
"$ref": "FirewallPolicyRule"
},
"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\nthe request.",
"flatPath": "projects/{project}/global/firewallPolicies",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all the policies that have been configured for the specified project.",
"flatPath": "projects/{project}/global/firewallPolicies",
"httpMethod": "GET",
"id": "compute.networkFirewallPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/firewallPolicies",
"response": {
"$ref": "FirewallPolicyList"
},
"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 policy with the data included in the request.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"httpMethod": "PATCH",
"id": "compute.networkFirewallPolicies.patch",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patchPacketMirroringRule": {
"description": "Patches a packet mirroring rule of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.patchPacketMirroringRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patchRule": {
"description": "Patches a rule of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.patchRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeAssociation": {
"description": "Removes an association for the specified firewall policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.removeAssociation",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"name": {
"description": "Name for the attachment that will be removed.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeAssociation",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removePacketMirroringRule": {
"description": "Deletes a packet mirroring rule of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.removePacketMirroringRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to remove from the firewall 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeRule": {
"description": "Deletes a rule of the specified priority.",
"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.removeRule",
"parameterOrder": [
"project",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to remove from the firewall 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule",
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/firewallPolicies/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.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": "projects/{project}/global/firewallPolicies/{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.",
"flatPath": "projects/{project}/global/firewallPolicies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.networkFirewallPolicies.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": "projects/{project}/global/firewallPolicies/{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"
]
}
}
},
"networkProfiles": {
"methods": {
"get": {
"description": "Returns the specified network profile.",
"flatPath": "projects/{project}/global/networkProfiles/{networkProfile}",
"httpMethod": "GET",
"id": "compute.networkProfiles.get",
"parameterOrder": [
"project",
"networkProfile"
],
"parameters": {
"networkProfile": {
"description": "Name of the network profile 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": "projects/{project}/global/networkProfiles/{networkProfile}",
"response": {
"$ref": "NetworkProfile"
},
"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 network profiles available to the specified\nproject.",
"flatPath": "projects/{project}/global/networkProfiles",
"httpMethod": "GET",
"id": "compute.networkProfiles.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/networkProfiles",
"response": {
"$ref": "NetworkProfilesListResponse"
},
"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.",
"flatPath": "projects/{project}/global/networks/{network}/addPeering",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"cancelRequestRemovePeering": {
"description": "Cancel requests to remove a peering from the specified network. Applicable\nonly for PeeringConnection with update_strategy=CONSENSUS.  Cancels a\nrequest to remove a peering from the specified network.",
"flatPath": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering",
"httpMethod": "POST",
"id": "compute.networks.cancelRequestRemovePeering",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/networks/{network}/cancelRequestRemovePeering",
"request": {
"$ref": "NetworksCancelRequestRemovePeeringRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified network.",
"flatPath": "projects/{project}/global/networks/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networks/{network}",
"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": "projects/{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"
]
},
"getEffectiveFirewalls": {
"description": "Returns the effective firewalls on a given network.",
"flatPath": "projects/{project}/global/networks/{network}/getEffectiveFirewalls",
"httpMethod": "GET",
"id": "compute.networks.getEffectiveFirewalls",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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": "projects/{project}/global/networks/{network}/getEffectiveFirewalls",
"response": {
"$ref": "NetworksGetEffectiveFirewallsResponse"
},
"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\nin the request.",
"flatPath": "projects/{project}/global/networks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networks",
"httpMethod": "GET",
"id": "compute.networks.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networks/{network}/listPeeringRoutes",
"httpMethod": "GET",
"id": "compute.networks.listPeeringRoutes",
"parameterOrder": [
"project",
"network"
],
"parameters": {
"direction": {
"description": "The direction of the exchanged routes.",
"enum": [
"INCOMING",
"OUTGOING"
],
"enumDescriptions": [
"For routes exported from peer network.",
"For routes exported from local network."
],
"location": "query",
"type": "string"
},
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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,\nstatic routes and dynamic routes in the region.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nOnly routingConfig can be modified.",
"flatPath": "projects/{project}/global/networks/{network}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/networks/{network}/removePeering",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"requestRemovePeering": {
"description": "Requests to remove a peering from the specified network. Applicable only\nfor PeeringConnection with update_strategy=CONSENSUS.",
"flatPath": "projects/{project}/global/networks/{network}/requestRemovePeering",
"httpMethod": "POST",
"id": "compute.networks.requestRemovePeering",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/networks/{network}/requestRemovePeering",
"request": {
"$ref": "NetworksRequestRemovePeeringRequest"
},
"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.",
"flatPath": "projects/{project}/global/networks/{network}/switchToCustomMode",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nrequest. You can only modify the NetworkPeering.export_custom_routes field\nand the NetworkPeering.import_custom_routes field.",
"flatPath": "projects/{project}/global/networks/{network}/updatePeering",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/addNodes",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nNote: use nodeGroups.listNodes for more details about each group.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/nodeGroups",
"httpMethod": "GET",
"id": "compute.nodeGroups.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/deleteNodes",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nby making a list() request.\nNote: the \"nodes\" field should not be used. Use nodeGroups.listNodes\ninstead.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.nodeGroups.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nNote: use nodeGroups.listNodes for more details about each group.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups",
"httpMethod": "GET",
"id": "compute.nodeGroups.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/listNodes",
"httpMethod": "POST",
"id": "compute.nodeGroups.listNodes",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"performMaintenance": {
"description": "Perform maintenance on a subset of nodes in the node group.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance",
"httpMethod": "POST",
"id": "compute.nodeGroups.performMaintenance",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the node group 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance",
"request": {
"$ref": "NodeGroupsPerformMaintenanceRequest"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/setNodeTemplate",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"simulateMaintenanceEvent": {
"description": "Simulates maintenance event on specified nodes from the node group.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent",
"httpMethod": "POST",
"id": "compute.nodeGroups.simulateMaintenanceEvent",
"parameterOrder": [
"project",
"zone",
"nodeGroup"
],
"parameters": {
"nodeGroup": {
"description": "Name of the NodeGroup resource whose nodes will go under maintenance\nsimulation.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/simulateMaintenanceEvent",
"request": {
"$ref": "NodeGroupsSimulateMaintenanceEventRequest"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/testIamPermissions",
"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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/nodeTemplates",
"httpMethod": "GET",
"id": "compute.nodeTemplates.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates/{nodeTemplate}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.nodeTemplates.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates",
"httpMethod": "GET",
"id": "compute.nodeTemplates.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/nodeTemplates/{resource}/testIamPermissions",
"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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/nodeTypes",
"httpMethod": "GET",
"id": "compute.nodeTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/nodeTypes/{nodeType}",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/zones/{zone}/nodeTypes",
"httpMethod": "GET",
"id": "compute.nodeTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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"
]
}
}
},
"organizationSecurityPolicies": {
"methods": {
"addAssociation": {
"description": "Inserts an association for the specified security policy.\n\nThis has billing implications.  Projects in the hierarchy with effective\nhierarchical security policies will be automatically enrolled into Cloud\nArmor Enterprise if not already enrolled.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.addAssociation\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/addAssociation",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.addAssociation",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"replaceExistingAssociation": {
"description": "Indicates whether or not to replace it if an association of the attachment\nalready exists. This is false by default, in which case an error will be\nreturned if an association already exists.",
"location": "query",
"type": "boolean"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/addAssociation",
"request": {
"$ref": "SecurityPolicyAssociation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addRule": {
"description": "Inserts a rule into a security policy.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.addRule instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/addRule",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.addRule",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/addRule",
"request": {
"$ref": "SecurityPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"copyRules": {
"description": "Copies rules to the specified security policy.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.cloneRules\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/copyRules",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.copyRules",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
},
"sourceSecurityPolicy": {
"description": "The security policy from which to copy rules.",
"location": "query",
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/copyRules",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified policy.\n\nUse this API to remove Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to remove firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.delete instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}",
"httpMethod": "DELETE",
"id": "compute.organizationSecurityPolicies.delete",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to delete.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/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.\n\nUse this API to read Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to read firewall policies. This usage is now\ndisabled for most organizations. Use firewallPolicies.get instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.get",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"securityPolicy": {
"description": "Name of the security policy to get.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/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"
]
},
"getAssociation": {
"description": "Gets an association with the specified name.\n\nUse this API to read Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to read firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.getAssociation\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/getAssociation",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.getAssociation",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"name": {
"description": "The name of the association to get from the security policy.",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to which the queried rule belongs.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/getAssociation",
"response": {
"$ref": "SecurityPolicyAssociation"
},
"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.\n\nUse this API to read Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to read firewall policies. This usage is now\ndisabled for most organizations. Use firewallPolicies.getRule instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/getRule",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.getRule",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to get from the security policy.",
"format": "int32",
"location": "query",
"type": "integer"
},
"securityPolicy": {
"description": "Name of the security policy to which the queried rule belongs.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/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 organization using the data included\nin the request.\n\nUse this API to add Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to add firewall policies. This usage is now\ndisabled for most organizations. Use firewallPolicies.insert instead.",
"flatPath": "locations/global/securityPolicies",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.insert",
"parameters": {
"parentId": {
"description": "Parent ID for this request. The ID can be either be \"folders/[FOLDER_ID]\"\nif the parent is a folder or \"organizations/[ORGANIZATION_ID]\" if the\nparent is an organization.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "locations/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\norganization.\n\nUse this API to read Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to read firewall policies. This usage is now\ndisabled for most organizations. Use firewallPolicies.list instead.",
"flatPath": "locations/global/securityPolicies",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.list",
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentId": {
"description": "Parent ID for this request.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "locations/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"
]
},
"listAssociations": {
"description": "Lists associations of a specified target, i.e., organization or folder.\n\nUse this API to read Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to read firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.listAssociations\ninstead.",
"flatPath": "locations/global/securityPolicies/listAssociations",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.listAssociations",
"parameters": {
"targetResource": {
"description": "The target resource to list associations. It is an organization, or a\nfolder.",
"location": "query",
"type": "string"
}
},
"path": "locations/global/securityPolicies/listAssociations",
"response": {
"$ref": "OrganizationSecurityPoliciesListAssociationsResponse"
},
"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)\nexpressions.",
"flatPath": "locations/global/securityPolicies/listPreconfiguredExpressionSets",
"httpMethod": "GET",
"id": "compute.organizationSecurityPolicies.listPreconfiguredExpressionSets",
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentId": {
"description": "Parent ID for this request.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "locations/global/securityPolicies/listPreconfiguredExpressionSets",
"response": {
"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"move": {
"description": "Moves the specified security policy.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.move instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/move",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.move",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"parentId": {
"description": "The new parent of the security policy.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/move",
"response": {
"$ref": "Operation"
},
"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.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.patch instead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}",
"httpMethod": "PATCH",
"id": "compute.organizationSecurityPolicies.patch",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/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.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.patchRule\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/patchRule",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.patchRule",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to patch.",
"format": "int32",
"location": "query",
"type": "integer"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/patchRule",
"request": {
"$ref": "SecurityPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeAssociation": {
"description": "Removes an association for the specified security policy.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.removeAssociation\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/removeAssociation",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.removeAssociation",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"name": {
"description": "Name for the attachment that will be removed.",
"location": "query",
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/removeAssociation",
"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.\n\nUse this API to modify Cloud Armor policies. Previously, alpha and beta\nversions of this API were used to modify firewall policies. This usage is\nnow disabled for most organizations. Use firewallPolicies.removeRule\ninstead.",
"flatPath": "locations/global/securityPolicies/{securityPolicy}/removeRule",
"httpMethod": "POST",
"id": "compute.organizationSecurityPolicies.removeRule",
"parameterOrder": [
"securityPolicy"
],
"parameters": {
"priority": {
"description": "The priority of the rule to remove from the security policy.",
"format": "int32",
"location": "query",
"type": "integer"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"securityPolicy": {
"description": "Name of the security policy to update.",
"location": "path",
"pattern": "(securityPolicies/)?[0-9]{0,20}",
"required": true,
"type": "string"
}
},
"path": "locations/global/securityPolicies/{securityPolicy}/removeRule",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"packetMirrorings": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of packetMirrorings.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/packetMirrorings",
"httpMethod": "GET",
"id": "compute.packetMirrorings.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"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": "projects/{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\nusing the data included in the request.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings",
"httpMethod": "GET",
"id": "compute.packetMirrorings.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nthe request. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{packetMirroring}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/packetMirrorings/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"previewFeatures": {
"methods": {
"get": {
"description": "Returns the details of the given PreviewFeature.",
"flatPath": "projects/{project}/global/previewFeatures/{previewFeature}",
"httpMethod": "GET",
"id": "compute.previewFeatures.get",
"parameterOrder": [
"project",
"previewFeature"
],
"parameters": {
"previewFeature": {
"description": "Name of the PreviewFeature 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"
}
},
"path": "projects/{project}/global/previewFeatures/{previewFeature}",
"response": {
"$ref": "PreviewFeature"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Returns the details of the given PreviewFeature.",
"flatPath": "projects/{project}/global/previewFeatures",
"httpMethod": "GET",
"id": "compute.previewFeatures.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/previewFeatures",
"response": {
"$ref": "PreviewFeatureList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Patches the given PreviewFeature. This method is used to enable or disable\na PreviewFeature.",
"flatPath": "projects/{project}/global/previewFeatures/{previewFeature}",
"httpMethod": "PATCH",
"id": "compute.previewFeatures.update",
"parameterOrder": [
"project",
"previewFeature"
],
"parameters": {
"previewFeature": {
"description": "Name of the PreviewFeature 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/previewFeatures/{previewFeature}",
"request": {
"$ref": "PreviewFeature"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"projects": {
"methods": {
"disableXpnHost": {
"description": "Disable this project as a shared VPC host project.",
"flatPath": "projects/{project}/disableXpnHost",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthis host project.",
"flatPath": "projects/{project}/disableXpnResource",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/enableXpnHost",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nsubnets in the host project can be used by instances in the service\nproject.",
"flatPath": "projects/{project}/enableXpnResource",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\n\nTo decrease latency for this method, you can optionally omit any unneeded\ninformation from the response by using a field mask. This practice is\nespecially recommended for unused quota information (the `quotas` field).\nTo exclude one or more fields, set your request's `fields` query parameter\nto only include the fields you need. For example, to only include the `id`\nand `selfLink` fields, add the query parameter `?fields=id,selfLink` to\nyour request.",
"flatPath": "projects/{project}",
"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": "projects/{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\nif no link exists.",
"flatPath": "projects/{project}/getXpnHost",
"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": "projects/{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\nproject.",
"flatPath": "projects/{project}/getXpnResources",
"httpMethod": "GET",
"id": "compute.projects.getXpnResources",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/listXpnHosts",
"httpMethod": "POST",
"id": "compute.projects.listXpnHosts",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/listXpnHosts",
"request": {
"$ref": "ProjectsListXpnHostsRequest"
},
"response": {
"$ref": "XpnHostList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"moveDisk": {
"deprecated": true,
"description": "Moves a persistent disk from one zone to another.\n*Note*: The moveDisk API will be deprecated on September 29, 2026.\n\nStarting September 29, 2025, you can't use the moveDisk API on new\nprojects. To move a disk to a different region or zone, follow the steps in\n[Change the location of a\ndisk](https://cloud.google.com/compute/docs/disks/migrate-to-hyperdisk#migrate-to-hd).\n\nProjects that already use the moveDisk API can continue usage until\nSeptember 29, 2026.\n\nStarting November 1, 2025, API responses will include a warning message in\nthe response body about the upcoming deprecation. You can skip the message\nto continue using the service without interruption.",
"flatPath": "projects/{project}/moveDisk",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/moveDisk",
"request": {
"$ref": "DiskMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"moveInstance": {
"deprecated": true,
"description": "Moves an instance and its attached persistent disks from one zone to\nanother.\n*Note*: Moving VMs or disks by using this method might\n cause unexpected behavior. For more information, see the [known\n issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).\n[Deprecated] This method is deprecated. See [moving instance across\nzones](/compute/docs/instances/moving-instance-across-zones) instead.",
"flatPath": "projects/{project}/moveInstance",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/moveInstance",
"request": {
"$ref": "InstanceMoveRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setCloudArmorTier": {
"description": "Sets the Cloud Armor tier of the project. To set ENTERPRISE or above the\nbilling account of the project must be subscribed to Cloud Armor\nEnterprise. See Subscribing\nto Cloud Armor Enterprise for more information.",
"flatPath": "projects/{project}/setCloudArmorTier",
"httpMethod": "POST",
"id": "compute.projects.setCloudArmorTier",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/setCloudArmorTier",
"request": {
"$ref": "ProjectsSetCloudArmorTierRequest"
},
"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\nthe data included in the request.",
"flatPath": "projects/{project}/setCommonInstanceMetadata",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nused when an address/forwardingRule/instance is created without specifying\nthe network tier field.",
"flatPath": "projects/{project}/setDefaultNetworkTier",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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 theusage export bucket\nwhere reports are stored. If you provide an empty request body using this\nmethod, the usage export feature will be disabled.",
"flatPath": "projects/{project}/setUsageExportBucket",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
}
}
},
"publicAdvertisedPrefixes": {
"methods": {
"announce": {
"description": "Announces the specified PublicAdvertisedPrefix",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce",
"httpMethod": "POST",
"id": "compute.publicAdvertisedPrefixes.announce",
"parameterOrder": [
"project",
"publicAdvertisedPrefix"
],
"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"
},
"publicAdvertisedPrefix": {
"description": "The name of the public advertised prefix. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/announce",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified PublicAdvertisedPrefix",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"httpMethod": "DELETE",
"id": "compute.publicAdvertisedPrefixes.delete",
"parameterOrder": [
"project",
"publicAdvertisedPrefix"
],
"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"
},
"publicAdvertisedPrefix": {
"description": "Name of the PublicAdvertisedPrefix 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified PublicAdvertisedPrefix resource.",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"httpMethod": "GET",
"id": "compute.publicAdvertisedPrefixes.get",
"parameterOrder": [
"project",
"publicAdvertisedPrefix"
],
"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"
},
"publicAdvertisedPrefix": {
"description": "Name of the PublicAdvertisedPrefix 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": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"response": {
"$ref": "PublicAdvertisedPrefix"
},
"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 PublicAdvertisedPrefix in the specified project\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
"httpMethod": "POST",
"id": "compute.publicAdvertisedPrefixes.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes",
"request": {
"$ref": "PublicAdvertisedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the PublicAdvertisedPrefixes for a project.",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes",
"httpMethod": "GET",
"id": "compute.publicAdvertisedPrefixes.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes",
"response": {
"$ref": "PublicAdvertisedPrefixList"
},
"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\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"httpMethod": "PATCH",
"id": "compute.publicAdvertisedPrefixes.patch",
"parameterOrder": [
"project",
"publicAdvertisedPrefix"
],
"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"
},
"publicAdvertisedPrefix": {
"description": "Name of the PublicAdvertisedPrefix 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}",
"request": {
"$ref": "PublicAdvertisedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"withdraw": {
"description": "Withdraws the specified PublicAdvertisedPrefix",
"flatPath": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw",
"httpMethod": "POST",
"id": "compute.publicAdvertisedPrefixes.withdraw",
"parameterOrder": [
"project",
"publicAdvertisedPrefix"
],
"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"
},
"publicAdvertisedPrefix": {
"description": "The name of the public advertised prefix. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/publicAdvertisedPrefixes/{publicAdvertisedPrefix}/withdraw",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"publicDelegatedPrefixes": {
"methods": {
"aggregatedList": {
"description": "Lists all PublicDelegatedPrefix resources owned by the specific project\nacross all scopes.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/publicDelegatedPrefixes",
"httpMethod": "GET",
"id": "compute.publicDelegatedPrefixes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/publicDelegatedPrefixes",
"response": {
"$ref": "PublicDelegatedPrefixAggregatedList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"announce": {
"description": "Announces the specified PublicDelegatedPrefix in the given region.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce",
"httpMethod": "POST",
"id": "compute.publicDelegatedPrefixes.announce",
"parameterOrder": [
"project",
"region",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "The name of the public delegated prefix. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "The name of theregion where\nthe public delegated prefix is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/announce",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified PublicDelegatedPrefix in the given region.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "DELETE",
"id": "compute.publicDelegatedPrefixes.delete",
"parameterOrder": [
"project",
"region",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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"
},
"region": {
"description": "Name of the region of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified PublicDelegatedPrefix resource in the given region.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "GET",
"id": "compute.publicDelegatedPrefixes.get",
"parameterOrder": [
"project",
"region",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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"
},
"region": {
"description": "Name of the region of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"response": {
"$ref": "PublicDelegatedPrefix"
},
"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 PublicDelegatedPrefix in the specified project in the given\nregion using the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
"httpMethod": "POST",
"id": "compute.publicDelegatedPrefixes.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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
"request": {
"$ref": "PublicDelegatedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the PublicDelegatedPrefixes for a project in the given region.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
"httpMethod": "GET",
"id": "compute.publicDelegatedPrefixes.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes",
"response": {
"$ref": "PublicDelegatedPrefixList"
},
"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 PublicDelegatedPrefix resource with the data included\nin the request. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"httpMethod": "PATCH",
"id": "compute.publicDelegatedPrefixes.patch",
"parameterOrder": [
"project",
"region",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "Name of the PublicDelegatedPrefix 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}",
"request": {
"$ref": "PublicDelegatedPrefix"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"withdraw": {
"description": "Withdraws the specified PublicDelegatedPrefix in the given region.",
"flatPath": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw",
"httpMethod": "POST",
"id": "compute.publicDelegatedPrefixes.withdraw",
"parameterOrder": [
"project",
"region",
"publicDelegatedPrefix"
],
"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"
},
"publicDelegatedPrefix": {
"description": "The name of the public delegated prefix. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "The name of theregion where\nthe public delegated prefix is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/publicDelegatedPrefixes/{publicDelegatedPrefix}/withdraw",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionAutoscalers": {
"methods": {
"delete": {
"description": "Deletes the specified autoscaler.",
"flatPath": "projects/{project}/regions/{region}/autoscalers/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/autoscalers/{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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/autoscalers",
"httpMethod": "GET",
"id": "compute.regionAutoscalers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nthe data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/autoscalers/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionAutoscalers.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": "projects/{project}/regions/{region}/autoscalers/{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 autoscaler in the specified project using\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/autoscalers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/autoscalers",
"request": {
"$ref": "Autoscaler"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionBackendBuckets": {
"methods": {
"delete": {
"description": "Deletes the specified regional BackendBucket resource.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}",
"httpMethod": "DELETE",
"id": "compute.regionBackendBuckets.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified regional BackendBucket resource.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}",
"httpMethod": "GET",
"id": "compute.regionBackendBuckets.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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": "projects/{project}/regions/{region}/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"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionBackendBuckets.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/backendBuckets/{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 RegionBackendBucket in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets",
"httpMethod": "POST",
"id": "compute.regionBackendBuckets.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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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\nproject in the given region.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets",
"httpMethod": "GET",
"id": "compute.regionBackendBuckets.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
},
"listUsable": {
"description": "Retrieves a list of all usable backend buckets in the specified project in\nthe given region.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/listUsable",
"httpMethod": "GET",
"id": "compute.regionBackendBuckets.listUsable",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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.\nIt must be a string that meets the requirements in RFC1035.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/backendBuckets/listUsable",
"response": {
"$ref": "BackendBucketListUsable"
},
"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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}",
"httpMethod": "PATCH",
"id": "compute.regionBackendBuckets.patch",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/backendBuckets/{backendBucket}",
"request": {
"$ref": "BackendBucket"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionBackendBuckets.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": "projects/{project}/regions/{region}/backendBuckets/{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.",
"flatPath": "projects/{project}/regions/{region}/backendBuckets/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionBackendBuckets.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": "projects/{project}/regions/{region}/backendBuckets/{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"
]
}
}
},
"regionBackendServices": {
"methods": {
"delete": {
"description": "Deletes the specified regional BackendService resource.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
"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": "projects/{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\nregional BackendService.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/getHealth",
"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": "projects/{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"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionBackendServices.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/backendServices/{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 regional BackendService resource in the specified project using\nthe data included in the request. For more information, see\nBackend services overview.",
"flatPath": "projects/{project}/regions/{region}/backendServices",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nspecified project in the given region.",
"flatPath": "projects/{project}/regions/{region}/backendServices",
"httpMethod": "GET",
"id": "compute.regionBackendServices.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"listUsable": {
"description": "Retrieves a list of all usable backend services in the specified project in\nthe given region.",
"flatPath": "projects/{project}/regions/{region}/backendServices/listUsable",
"httpMethod": "GET",
"id": "compute.regionBackendServices.listUsable",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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.\nIt must be a string that meets the requirements in RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/backendServices/listUsable",
"response": {
"$ref": "BackendServiceListUsable"
},
"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\nincluded in the request. For more information, see \nUnderstanding backend services This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionBackendServices.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": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy",
"request": {
"$ref": "RegionSetPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSecurityPolicy": {
"description": "Sets the Google Cloud Armor security policy for the specified backend\nservice. For more information, seeGoogle\nCloud Armor Overview",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy",
"httpMethod": "POST",
"id": "compute.regionBackendServices.setSecurityPolicy",
"parameterOrder": [
"project",
"region",
"backendService"
],
"parameters": {
"backendService": {
"description": "Name of the BackendService resource to which the security policy should be\nset. 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionBackendServices.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": "projects/{project}/regions/{region}/backendServices/{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 the specified regional BackendService resource with the data\nincluded in the request. For more information,\nsee \nBackend services overview.",
"flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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 by region.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/commitments",
"httpMethod": "GET",
"id": "compute.regionCommitments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/commitments",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/commitments",
"httpMethod": "GET",
"id": "compute.regionCommitments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"update": {
"description": "Updates the specified commitment with the data included in the request.\nUpdate is performed only on selected fields included as part of\nupdate-mask. Only the following fields can be updated: auto_renew and plan.",
"flatPath": "projects/{project}/regions/{region}/commitments/{commitment}",
"httpMethod": "PATCH",
"id": "compute.regionCommitments.update",
"parameterOrder": [
"project",
"region",
"commitment"
],
"parameters": {
"commitment": {
"description": "Name of the commitment that you want 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"
},
"paths": {
"location": "query",
"repeated": 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/commitments/{commitment}",
"request": {
"$ref": "Commitment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionCompositeHealthChecks": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all CompositeHealthCheck resources (all\nregional) available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/compositeHealthChecks",
"httpMethod": "GET",
"id": "compute.regionCompositeHealthChecks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/compositeHealthChecks",
"response": {
"$ref": "CompositeHealthCheckAggregatedList"
},
"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 CompositeHealthCheck in the given region",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"httpMethod": "DELETE",
"id": "compute.regionCompositeHealthChecks.delete",
"parameterOrder": [
"project",
"region",
"compositeHealthCheck"
],
"parameters": {
"compositeHealthCheck": {
"description": "Name of the CompositeHealthCheck 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified CompositeHealthCheck resource in the given region.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"httpMethod": "GET",
"id": "compute.regionCompositeHealthChecks.get",
"parameterOrder": [
"project",
"region",
"compositeHealthCheck"
],
"parameters": {
"compositeHealthCheck": {
"description": "Name of the CompositeHealthCheck 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": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"response": {
"$ref": "CompositeHealthCheck"
},
"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\nregional CompositeHealthCheck.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth",
"httpMethod": "GET",
"id": "compute.regionCompositeHealthChecks.getHealth",
"parameterOrder": [
"project",
"region",
"compositeHealthCheck"
],
"parameters": {
"compositeHealthCheck": {
"description": "Name of the CompositeHealthCheck resource to get health 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": "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"
},
"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": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}/getHealth",
"response": {
"$ref": "CompositeHealthCheckHealth"
},
"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 CompositeHealthCheck in the specified project in the given region\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks",
"httpMethod": "POST",
"id": "compute.regionCompositeHealthChecks.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/compositeHealthChecks",
"request": {
"$ref": "CompositeHealthCheck"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the CompositeHealthChecks for a project in the given region.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks",
"httpMethod": "GET",
"id": "compute.regionCompositeHealthChecks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/compositeHealthChecks",
"response": {
"$ref": "CompositeHealthCheckList"
},
"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 CompositeHealthCheck resource\nwith the data included in the request.  This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"httpMethod": "PATCH",
"id": "compute.regionCompositeHealthChecks.patch",
"parameterOrder": [
"project",
"region",
"compositeHealthCheck"
],
"parameters": {
"compositeHealthCheck": {
"description": "Name of the CompositeHealthCheck to update. The name\nmust be 1-63 characters long, and 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/compositeHealthChecks/{compositeHealthCheck}",
"request": {
"$ref": "CompositeHealthCheck"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/compositeHealthChecks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionCompositeHealthChecks.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": "projects/{project}/regions/{region}/compositeHealthChecks/{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"
]
}
}
},
"regionDiskTypes": {
"methods": {
"get": {
"description": "Returns the specified regional disk type.",
"flatPath": "projects/{project}/regions/{region}/diskTypes/{diskType}",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/diskTypes",
"httpMethod": "GET",
"id": "compute.regionDiskTypes.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\npolicy which will be applied to this disk for scheduling snapshot\ncreation.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/addResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"bulkInsert": {
"description": "Bulk create a set of disks.",
"flatPath": "projects/{project}/regions/{region}/disks/bulkInsert",
"httpMethod": "POST",
"id": "compute.regionDisks.bulkInsert",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/bulkInsert",
"request": {
"$ref": "BulkInsertDiskResource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"createSnapshot": {
"description": "Creates a snapshot of a specified persistent disk. For regular snapshot\ncreation, consider using snapshots.insert\ninstead, as that method supports more features, such as creating snapshots\nin a project different from the source disk project.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/createSnapshot",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nremoves all the replicas of its data permanently and is irreversible.\nHowever, deleting a disk does not delete anysnapshots\npreviously made from the disk. You must separatelydelete\nsnapshots.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}",
"httpMethod": "DELETE",
"id": "compute.regionDisks.delete",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the regional persistent disk to delete.",
"location": "path",
"pattern": "\\S{1,66}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/disks/{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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/disks/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionDisks.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/disks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceImage": {
"description": "Source image to restore onto a disk. This field is optional.",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/disks",
"httpMethod": "GET",
"id": "compute.regionDisks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/removeResourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/resize",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/disks/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/disks/{resource}/setLabels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"startAsyncReplication": {
"description": "Starts asynchronous replication.\nMust be invoked on the primary disk.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication",
"httpMethod": "POST",
"id": "compute.regionDisks.startAsyncReplication",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/{disk}/startAsyncReplication",
"request": {
"$ref": "RegionDisksStartAsyncReplicationRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopAsyncReplication": {
"description": "Stops asynchronous replication.\nCan be invoked either on the primary or on the secondary disk.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication",
"httpMethod": "POST",
"id": "compute.regionDisks.stopAsyncReplication",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/{disk}/stopAsyncReplication",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopGroupAsyncReplication": {
"description": "Stops asynchronous replication for a consistency group of disks.\nCan be invoked either in the primary or secondary scope.",
"flatPath": "projects/{project}/regions/{region}/disks/stopGroupAsyncReplication",
"httpMethod": "POST",
"id": "compute.regionDisks.stopGroupAsyncReplication",
"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. This must be the region of the\nprimary or secondary disks in the consistency group.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/stopGroupAsyncReplication",
"request": {
"$ref": "DisksStopGroupAsyncReplicationResource"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/disks/{resource}/testIamPermissions",
"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": "projects/{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"
]
},
"update": {
"description": "Update the specified disk with the data included in the request. Update is\nperformed only on selected fields included as part of update-mask.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}",
"httpMethod": "PATCH",
"id": "compute.regionDisks.update",
"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"
},
"paths": {
"location": "query",
"repeated": 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/{disk}",
"request": {
"$ref": "Disk"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updateKmsKey": {
"description": "Rotates the customer-managed\nencryption key to the latest version for the specified persistent disk.",
"flatPath": "projects/{project}/regions/{region}/disks/{disk}/updateKmsKey",
"httpMethod": "POST",
"id": "compute.regionDisks.updateKmsKey",
"parameterOrder": [
"project",
"region",
"disk"
],
"parameters": {
"disk": {
"description": "Name of the Disk resource, 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 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/disks/{disk}/updateKmsKey",
"request": {
"$ref": "RegionDiskUpdateKmsKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionHealthAggregationPolicies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all HealthAggregationPolicy resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/healthAggregationPolicies",
"httpMethod": "GET",
"id": "compute.regionHealthAggregationPolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/healthAggregationPolicies",
"response": {
"$ref": "HealthAggregationPolicyAggregatedList"
},
"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 HealthAggregationPolicy in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"httpMethod": "DELETE",
"id": "compute.regionHealthAggregationPolicies.delete",
"parameterOrder": [
"project",
"region",
"healthAggregationPolicy"
],
"parameters": {
"healthAggregationPolicy": {
"description": "Name of the HealthAggregationPolicy 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HealthAggregationPolicy resource in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"httpMethod": "GET",
"id": "compute.regionHealthAggregationPolicies.get",
"parameterOrder": [
"project",
"region",
"healthAggregationPolicy"
],
"parameters": {
"healthAggregationPolicy": {
"description": "Name of the HealthAggregationPolicy 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": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"response": {
"$ref": "HealthAggregationPolicy"
},
"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 HealthAggregationPolicy in the specified project in the given\nregion using the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies",
"httpMethod": "POST",
"id": "compute.regionHealthAggregationPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthAggregationPolicies",
"request": {
"$ref": "HealthAggregationPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the HealthAggregationPolicies for a project in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies",
"httpMethod": "GET",
"id": "compute.regionHealthAggregationPolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/healthAggregationPolicies",
"response": {
"$ref": "HealthAggregationPolicyList"
},
"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 HealthAggregationPolicy\nresource with the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"httpMethod": "PATCH",
"id": "compute.regionHealthAggregationPolicies.patch",
"parameterOrder": [
"project",
"region",
"healthAggregationPolicy"
],
"parameters": {
"healthAggregationPolicy": {
"description": "Name of the HealthAggregationPolicy to update. The name\nmust be 1-63 characters long, and 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthAggregationPolicies/{healthAggregationPolicy}",
"request": {
"$ref": "HealthAggregationPolicy"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/healthAggregationPolicies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionHealthAggregationPolicies.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": "projects/{project}/regions/{region}/healthAggregationPolicies/{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"
]
}
}
},
"regionHealthCheckServices": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all HealthCheckService resources,\nregional and global, available to the specified project.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/healthCheckServices",
"httpMethod": "GET",
"id": "compute.regionHealthCheckServices.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/healthCheckServices",
"response": {
"$ref": "HealthCheckServiceAggregatedList"
},
"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 regional HealthCheckService.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"httpMethod": "DELETE",
"id": "compute.regionHealthCheckServices.delete",
"parameterOrder": [
"project",
"region",
"healthCheckService"
],
"parameters": {
"healthCheckService": {
"description": "Name of the HealthCheckService to delete. The name\nmust be 1-63 characters long, and 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified regional HealthCheckService resource.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"httpMethod": "GET",
"id": "compute.regionHealthCheckServices.get",
"parameterOrder": [
"project",
"region",
"healthCheckService"
],
"parameters": {
"healthCheckService": {
"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and 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"
},
"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": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"response": {
"$ref": "HealthCheckService"
},
"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 HealthCheckService resource in the\nspecified project and region using the data included in the request.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices",
"httpMethod": "POST",
"id": "compute.regionHealthCheckServices.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthCheckServices",
"request": {
"$ref": "HealthCheckService"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all the HealthCheckService resources that have been\nconfigured for the specified project in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices",
"httpMethod": "GET",
"id": "compute.regionHealthCheckServices.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/healthCheckServices",
"response": {
"$ref": "HealthCheckServicesList"
},
"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 HealthCheckService resource\nwith the data included in the request.  This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"httpMethod": "PATCH",
"id": "compute.regionHealthCheckServices.patch",
"parameterOrder": [
"project",
"region",
"healthCheckService"
],
"parameters": {
"healthCheckService": {
"description": "Name of the HealthCheckService to update. The name\nmust be 1-63 characters long, and 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthCheckServices/{healthCheckService}",
"request": {
"$ref": "HealthCheckService"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/healthCheckServices/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionHealthCheckServices.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": "projects/{project}/regions/{region}/healthCheckServices/{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.",
"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/healthChecks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/regions/{region}/healthChecks",
"httpMethod": "GET",
"id": "compute.regionHealthChecks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nincluded in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/regions/{region}/healthChecks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionHealthChecks.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": "projects/{project}/regions/{region}/healthChecks/{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 a HealthCheck resource in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/healthChecks/{healthCheck}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
}
}
},
"regionHealthSources": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all HealthSource resources (all\nregional) available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/healthSources",
"httpMethod": "GET",
"id": "compute.regionHealthSources.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/healthSources",
"response": {
"$ref": "HealthSourceAggregatedList"
},
"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 HealthSource in the given region",
"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"httpMethod": "DELETE",
"id": "compute.regionHealthSources.delete",
"parameterOrder": [
"project",
"region",
"healthSource"
],
"parameters": {
"healthSource": {
"description": "Name of the HealthSource 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified HealthSource resource in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"httpMethod": "GET",
"id": "compute.regionHealthSources.get",
"parameterOrder": [
"project",
"region",
"healthSource"
],
"parameters": {
"healthSource": {
"description": "Name of the HealthSource 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": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"response": {
"$ref": "HealthSource"
},
"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\nregional HealthSource.",
"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth",
"httpMethod": "GET",
"id": "compute.regionHealthSources.getHealth",
"parameterOrder": [
"project",
"region",
"healthSource"
],
"parameters": {
"healthSource": {
"description": "Name of the HealthSource resource to get health 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": "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"
},
"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": "projects/{project}/regions/{region}/healthSources/{healthSource}/getHealth",
"response": {
"$ref": "HealthSourceHealth"
},
"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 HealthSource in the specified project in the given region\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/healthSources",
"httpMethod": "POST",
"id": "compute.regionHealthSources.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthSources",
"request": {
"$ref": "HealthSource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the HealthSources for a project in the given region.",
"flatPath": "projects/{project}/regions/{region}/healthSources",
"httpMethod": "GET",
"id": "compute.regionHealthSources.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/healthSources",
"response": {
"$ref": "HealthSourceList"
},
"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 HealthSource resource\nwith the data included in the request.  This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"httpMethod": "PATCH",
"id": "compute.regionHealthSources.patch",
"parameterOrder": [
"project",
"region",
"healthSource"
],
"parameters": {
"healthSource": {
"description": "Name of the HealthSource to update. The name\nmust be 1-63 characters long, and 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/healthSources/{healthSource}",
"request": {
"$ref": "HealthSource"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/healthSources/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionHealthSources.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": "projects/{project}/regions/{region}/healthSources/{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"
]
}
}
},
"regionInstanceGroupManagerResizeRequests": {
"methods": {
"cancel": {
"description": "Cancels the specified resize request.\nCancelled resize request no longer waits for the resources to be\nprovisioned. Cancel is only possible for requests that are in accepted\nstate.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagerResizeRequests.cancel",
"parameterOrder": [
"project",
"region",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.",
"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\nscoping this request. Name 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resizeRequest": {
"description": "The name of the resize request to cancel.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified, inactive resize request. Requests that are still\nactive cannot be deleted. Deleting request does not delete instances that\nwere provisioned previously.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"httpMethod": "DELETE",
"id": "compute.regionInstanceGroupManagerResizeRequests.delete",
"parameterOrder": [
"project",
"region",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.",
"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\nscoping this request. Name 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resizeRequest": {
"description": "The name of the resize request to delete.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"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 resize request.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagerResizeRequests.get",
"parameterOrder": [
"project",
"region",
"instanceGroupManager",
"resizeRequest"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nName should conform to RFC1035 or be a resource ID.",
"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\nscoping this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"resizeRequest": {
"description": "The name of the resize request.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}",
"response": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"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 Resize Request that starts provisioning VMs immediately\nor queues VM creation.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagerResizeRequests.insert",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "Name of the managed instance group to which the resize request is scoped.\nName should conform to RFC1035 or be a resource ID.",
"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\nscoping this request. Name 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"request": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of Resize Requests that are contained in the\nmanaged instance group.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagerResizeRequests.list",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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\nscoping this request. Name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests",
"response": {
"$ref": "RegionInstanceGroupManagerResizeRequestsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"regionInstanceGroupManagers": {
"methods": {
"abandonInstances": {
"description": "Flags the specified instances to be immediately removed from the managed\ninstance group. Abandoning an instance does not delete the\ninstance, but it does remove the instance from any target pools that are\napplied by the managed instance group. This method reduces thetargetSize of the managed instance group by the\nnumber of instances that you abandon. This operation is marked asDONE when the action is scheduled even if the instances have\nnot yet been removed from the group. You must separately verify the\nstatus of the abandoning action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/abandonInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/applyUpdatesToInstances",
"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": "projects/{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 configurations in this regional managed\ninstance group. Instances are created using the current instance template.\nThe create instances operation is marked DONE if\nthe createInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thecreating or actions with the listmanagedinstances\nmethod.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/createInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.createInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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 theregion\nwhere the managed instance group is located.\nIt 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nin that group.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nimmediately deleted. The instances are also removed from any target\npools of which they were a member. This method reduces thetargetSize of the managed instance group by the number of\ninstances that you delete.\nThe deleteInstances operation is marked DONE if\nthe deleteInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of thedeleting action with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deleteInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"deletePerInstanceConfigs": {
"description": "Deletes selected per-instance configurations for the managed instance\ngroup.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.deletePerInstanceConfigs",
"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": "Name of the region scoping this request, should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/deletePerInstanceConfigs",
"request": {
"$ref": "RegionInstanceGroupManagerDeleteInstanceConfigReq"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"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": "projects/{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\nin the request. After the group is created, instances in the group are\ncreated using the specified instance template.\nThis operation is marked as DONE when the group is created\neven if the instances in the group have not yet been created. You must\nseparately verify the status of the individual instances with thelistmanagedinstances\nmethod.\n\nA regional managed instance group can contain up to 2000 instances.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nwithin the specified region.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nmanaged instance group. The filter andorderBy query parameters are not supported.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listErrors",
"httpMethod": "GET",
"id": "compute.regionInstanceGroupManagers.listErrors",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt must be a string that meets the requirements in RFC1035, or an\nunsigned long integer: must match regexp pattern:\n(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)|1-9{0,19}.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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.\nThis should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nscheduled to be created. The list includes any current actions\nthat the group has scheduled for its instances. The orderBy\nquery parameter is not supported.   The `pageToken` query parameter is\nsupported only if the group's `listManagedInstancesResults` field is set\nto `PAGINATED`.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listManagedInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.listManagedInstances",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"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.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"listPerInstanceConfigs": {
"description": "Lists all of the per-instance configurations defined for the managed\ninstance group. The orderBy query parameter is not supported.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.listPerInstanceConfigs",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroupManager": {
"description": "The name of the managed instance group. It should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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, should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/listPerInstanceConfigs",
"response": {
"$ref": "RegionInstanceGroupManagersListInstanceConfigsResp"
},
"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\nin the request.\nThis operation is marked as DONE when the group is patched\neven if the instances in the group are still in the process of being\npatched. You must separately verify the status of the individual instances\nwith the listmanagedinstances\nmethod. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.\n\nIf you update your group to specify a new template or instance\nconfiguration, it's possible that your intended specification for each VM\nin the group is different from the current state of that VM. To learn how\nto apply an updated configuration to the VMs in a MIG, seeUpdating instances in\na MIG.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"patchPerInstanceConfigs": {
"description": "Inserts or patches per-instance configurations for the managed instance\ngroup. perInstanceConfig.name serves as a key used to\ndistinguish whether to perform insert or patch.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.patchPerInstanceConfigs",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/patchPerInstanceConfigs",
"request": {
"$ref": "RegionInstanceGroupManagerPatchInstanceConfigReq"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"recreateInstances": {
"description": "Flags the specified VM instances in the managed instance group to be\nimmediately recreated. Each instance is recreated using the group's current\nconfiguration. This operation is marked as DONE when the flag\nis set even if the instances have not yet been recreated. You must\nseparately verify the status of each instance by checking itscurrentAction field; for more information, see Checking\nthe status of managed instances.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining 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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/recreateInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nthe size, the group creates new instances using the current instance\ntemplate. If you decrease the size, the group deletes one or more\ninstances.\n\nThe resize operation is marked DONE if theresize request is successful. The underlying actions take\nadditional time. You must separately verify the status of thecreating or deleting actions with thelistmanagedinstances\nmethod.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is removed or deleted.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"size": {
"description": "Number of instances that should exist in this instance group\nmanager.",
"format": "int32",
"location": "query",
"minimum": "0",
"required": true,
"type": "integer"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resumeInstances": {
"description": "Flags the specified instances in the managed instance group to be\nresumed. This method increases thetargetSize and decreases the targetSuspendedSize\nof the managed instance group by the number of instances that you resume.\nThe resumeInstances operation is marked DONE if\nthe resumeInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theRESUMING action with thelistmanagedinstances\nmethod.\n\nIn this request, you can only specify instances that are suspended. For\nexample, if an instance was previously suspended using the suspendInstances\nmethod, it can be resumed using the resumeInstances method.\n\nIf a health check is attached to the managed instance group, the specified\ninstances will be verified as healthy after they are resumed.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.resumeInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances",
"request": {
"$ref": "RegionInstanceGroupManagersResumeInstancesRequest"
},
"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\ninstances in this group. Existing instances are not affected.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nassigned. Existing instances in the group are not affected.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"startInstances": {
"description": "Flags the specified instances in the managed instance group to be\nstarted. This method increases thetargetSize and decreases the targetStoppedSize\nof the managed instance group by the number of instances that you start.\nThe startInstances operation is marked DONE if\nthe startInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSTARTING action with thelistmanagedinstances\nmethod.\n\nIn this request, you can only specify instances that are stopped. For\nexample, if an instance was previously stopped using the stopInstances\nmethod, it can be started using the startInstances method.\n\nIf a health check is attached to the managed instance group, the specified\ninstances will be verified as healthy after they are started.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.startInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances",
"request": {
"$ref": "RegionInstanceGroupManagersStartInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"stopInstances": {
"description": "Flags the specified instances in the managed instance group to be\nimmediately stopped. You can only specify instances that are running in\nthis request. This method reduces thetargetSize and increases the targetStoppedSize\nof the managed instance group by the number of instances that you stop.\nThe stopInstances operation is marked DONE if\nthe stopInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSTOPPING action with thelistmanagedinstances\nmethod.\n\nIf the standbyPolicy.initialDelaySec field is set, the group\ndelays stopping the instances until initialDelaySec have\npassed from instance.creationTimestamp (that is, when the\ninstance was created). This delay gives your application time to\nset itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there\nwill be zero delay.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is stopped.\n\nStopped instances can be started using the startInstances\nmethod.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.stopInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances",
"request": {
"$ref": "RegionInstanceGroupManagersStopInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"suspendInstances": {
"description": "Flags the specified instances in the managed instance group to be\nimmediately suspended. You can only specify instances that are running in\nthis request. This method reduces thetargetSize and increases the targetSuspendedSize\nof the managed instance group by the number of instances that you suspend.\nThe suspendInstances operation is marked DONE if\nthe suspendInstances request is successful. The underlying\nactions take additional time. You must separately verify the status of theSUSPENDING action with thelistmanagedinstances\nmethod.\n\nIf the standbyPolicy.initialDelaySec field is set, the group\ndelays suspension of the instances until initialDelaySec have\npassed from instance.creationTimestamp (that is, when the\ninstance was created). This delay gives your application time to\nset itself up and initialize on the instance. If more thaninitialDelaySec seconds have passed sinceinstance.creationTimestamp when this method is called, there\nwill be zero delay.\n\nIf the group is part of a backend\nservice that has enabled\nconnection draining, it can take up to 60 seconds after the connection\ndraining duration has elapsed before the VM instance is suspended.\n\nSuspended instances can be resumed using the resumeInstances\nmethod.\n\nYou can specify a maximum of 1000 instances with this method per request.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.suspendInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances",
"request": {
"$ref": "RegionInstanceGroupManagersSuspendInstancesRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"updatePerInstanceConfigs": {
"description": "Inserts or updates per-instance configurations for the managed instance\ngroup. perInstanceConfig.name serves as a key used to\ndistinguish whether to perform insert or patch.",
"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
"httpMethod": "POST",
"id": "compute.regionInstanceGroupManagers.updatePerInstanceConfigs",
"parameterOrder": [
"project",
"region",
"instanceGroupManager"
],
"parameters": {
"instanceGroupManager": {
"description": "The name of the managed instance group.\nIt 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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/updatePerInstanceConfigs",
"request": {
"$ref": "RegionInstanceGroupManagerUpdateInstanceConfigReq"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}",
"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": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/instanceGroups",
"httpMethod": "GET",
"id": "compute.regionInstanceGroups.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\ninformation about the named ports. Depending on the specified options, this\nmethod can list all instances or only the instances that are running.\nThe orderBy query parameter is not supported.",
"flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/listInstances",
"httpMethod": "POST",
"id": "compute.regionInstanceGroups.listInstances",
"parameterOrder": [
"project",
"region",
"instanceGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"instanceGroup": {
"description": "Name of the regional instance group for which we want to list the\ninstances.",
"location": "path",
"required": true,
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/instanceGroups/{instanceGroup}/setNamedPorts",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/regions/{region}/instanceGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionInstanceGroups.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": "projects/{project}/regions/{region}/instanceGroups/{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"
]
}
}
},
"regionInstanceTemplates": {
"methods": {
"delete": {
"description": "Deletes the specified instance template. Deleting an instance template is\npermanent and cannot be undone.",
"flatPath": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}",
"httpMethod": "DELETE",
"id": "compute.regionInstanceTemplates.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/instanceTemplates/{instanceTemplate}",
"httpMethod": "GET",
"id": "compute.regionInstanceTemplates.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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": "projects/{project}/regions/{region}/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"
]
},
"insert": {
"description": "Creates an instance template in the specified project and region using the\nglobal instance template whose URL is included in the request.",
"flatPath": "projects/{project}/regions/{region}/instanceTemplates",
"httpMethod": "POST",
"id": "compute.regionInstanceTemplates.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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\nspecified project and region.",
"flatPath": "projects/{project}/regions/{region}/instanceTemplates",
"httpMethod": "GET",
"id": "compute.regionInstanceTemplates.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 regions for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
}
}
},
"regionInstances": {
"methods": {
"bulkInsert": {
"description": "Creates multiple instances in a given region. Count specifies the number of\ninstances to create.",
"flatPath": "projects/{project}/regions/{region}/instances/bulkInsert",
"httpMethod": "POST",
"id": "compute.regionInstances.bulkInsert",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instances/bulkInsert",
"request": {
"$ref": "BulkInsertInstanceResource"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionInstantSnapshotGroups": {
"methods": {
"delete": {
"description": "deletes a Regional InstantSnapshotGroup resource",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}",
"httpMethod": "DELETE",
"id": "compute.regionInstantSnapshotGroups.delete",
"parameterOrder": [
"project",
"region",
"instantSnapshotGroup"
],
"parameters": {
"instantSnapshotGroup": {
"description": "Name of the InstantSnapshotGroup 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "returns the specified InstantSnapshotGroup resource in the specified\nregion.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshotGroups.get",
"parameterOrder": [
"project",
"region",
"instantSnapshotGroup"
],
"parameters": {
"instantSnapshotGroup": {
"description": "Name of the InstantSnapshotGroup 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": "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": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}",
"response": {
"$ref": "InstantSnapshotGroup"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshotGroups.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/instantSnapshotGroups/{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 Regional InstantSnapshotGroup resource",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshotGroups.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceConsistencyGroup": {
"description": "begin_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshotGroups",
"request": {
"$ref": "InstantSnapshotGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "retrieves the list of InstantSnapshotGroup resources contained within\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshotGroups.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshotGroups",
"response": {
"$ref": "ListInstantSnapshotGroups"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshotGroups.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": "projects/{project}/regions/{region}/instantSnapshotGroups/{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.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshotGroups.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": "projects/{project}/regions/{region}/instantSnapshotGroups/{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"
]
}
}
},
"regionInstantSnapshots": {
"methods": {
"delete": {
"description": "Deletes the specified InstantSnapshot resource. Keep in mind that deleting\na single instantSnapshot might not necessarily delete all the data on that\ninstantSnapshot. If any data on the instantSnapshot that is marked for\ndeletion is needed for subsequent instantSnapshots, the data will be moved\nto the next corresponding instantSnapshot.\n\nFor more information, seeDeleting\ninstantSnapshots.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}",
"httpMethod": "DELETE",
"id": "compute.regionInstantSnapshots.delete",
"parameterOrder": [
"project",
"region",
"instantSnapshot"
],
"parameters": {
"instantSnapshot": {
"description": "Name of the InstantSnapshot 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified InstantSnapshot resource in the specified region.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshots.get",
"parameterOrder": [
"project",
"region",
"instantSnapshot"
],
"parameters": {
"instantSnapshot": {
"description": "Name of the InstantSnapshot 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": "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": "projects/{project}/regions/{region}/instantSnapshots/{instantSnapshot}",
"response": {
"$ref": "InstantSnapshot"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshots.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/instantSnapshots/{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 instant snapshot in the specified region.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshots",
"request": {
"$ref": "InstantSnapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of InstantSnapshot resources contained within\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots",
"httpMethod": "GET",
"id": "compute.regionInstantSnapshots.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/instantSnapshots",
"response": {
"$ref": "InstantSnapshotList"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshots.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": "projects/{project}/regions/{region}/instantSnapshots/{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 a instantSnapshot in the given region. To learn more\nabout labels, read the Labeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/instantSnapshots/{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.",
"flatPath": "projects/{project}/regions/{region}/instantSnapshots/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionInstantSnapshots.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": "projects/{project}/regions/{region}/instantSnapshots/{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"
]
}
}
},
"regionNetworkEndpointGroups": {
"methods": {
"attachNetworkEndpoints": {
"description": "Attach a list of network endpoints to the specified network endpoint group.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints",
"parameterOrder": [
"project",
"region",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group where you are attaching network\nendpoints 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"
},
"region": {
"description": "The name of the region where\nyou want to create the network endpoint group. It should comply with\nRFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints",
"request": {
"$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest"
},
"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\ndeleted if it is configured as a backend of a backend service.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
"httpMethod": "DELETE",
"id": "compute.regionNetworkEndpointGroups.delete",
"parameterOrder": [
"project",
"region",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group to delete. It should comply with\nRFC1035.",
"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\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints",
"parameterOrder": [
"project",
"region",
"networkEndpointGroup"
],
"parameters": {
"networkEndpointGroup": {
"description": "The name of the network endpoint group you are detaching network\nendpoints from. 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"
},
"region": {
"description": "The name of the region where\nthe network endpoint group is located. It should comply with\nRFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints",
"request": {
"$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}",
"httpMethod": "GET",
"id": "compute.regionNetworkEndpointGroups.get",
"parameterOrder": [
"project",
"region",
"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"
},
"region": {
"description": "The name of the region where\nthe network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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\nparameters that are included in the request.\n\nNote: Use the following APIs to manage network endpoint groups:\n   \n   - \n   To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n   NEGs): zonal\n   API\n   - \n   To manage NEGs with regional scope (such as regional internet NEGs,\n   serverless NEGs, Private Service Connect NEGs): regional\n   API\n   - \n   To manage NEGs with global scope (such as global internet NEGs):global\n   API",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.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 where\nyou want to create the network endpoint group. It should comply with\nRFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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 regional network endpoint groups available to the\nspecified project in the given region.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups",
"httpMethod": "GET",
"id": "compute.regionNetworkEndpointGroups.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 theregion\nwhere the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints",
"httpMethod": "POST",
"id": "compute.regionNetworkEndpointGroups.listNetworkEndpoints",
"parameterOrder": [
"project",
"region",
"networkEndpointGroup"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nlist 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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 theregion\nwhere the network endpoint group is located. It should comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
}
}
},
"regionNetworkFirewallPolicies": {
"methods": {
"addAssociation": {
"description": "Inserts an association for the specified network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.addAssociation",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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"
},
"replaceExistingAssociation": {
"description": "Indicates whether or not to replace it if an association already exists.\nThis is false by default, in which case an error will be returned if an\nassociation already exists.",
"location": "query",
"type": "boolean"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addAssociation",
"request": {
"$ref": "FirewallPolicyAssociation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"addRule": {
"description": "Inserts a rule into a network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.addRule",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"maxPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"format": "int32",
"location": "query",
"type": "integer"
},
"minPriority": {
"description": "When rule.priority is not specified, auto choose a unused priority betweenminPriority and maxPriority>.\nThis field is exclusive with rule.priority.",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/addRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"cloneRules": {
"description": "Copies rules to the specified network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.cloneRules",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"sourceFirewallPolicy": {
"description": "The firewall policy from which to copy rules.",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/cloneRules",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes the specified network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"httpMethod": "DELETE",
"id": "compute.regionNetworkFirewallPolicies.delete",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.get",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"response": {
"$ref": "FirewallPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getAssociation": {
"description": "Gets an association with the specified name.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.getAssociation",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall policy to which the queried association belongs.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"name": {
"description": "The name of the association to get from the firewall policy.",
"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": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getAssociation",
"response": {
"$ref": "FirewallPolicyAssociation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getEffectiveFirewalls": {
"description": "Returns the effective firewalls on a given network.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.getEffectiveFirewalls",
"parameterOrder": [
"project",
"region",
"network"
],
"parameters": {
"network": {
"description": "Network reference",
"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"
},
"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": "projects/{project}/regions/{region}/firewallPolicies/getEffectiveFirewalls",
"response": {
"$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/firewallPolicies/{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"
]
},
"getRule": {
"description": "Gets a rule of the specified priority.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.getRule",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to get from the firewall 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"
},
"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": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/getRule",
"response": {
"$ref": "FirewallPolicyRule"
},
"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 network firewall policy in the specified project and region.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.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\nso that if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all the network firewall policies that have been configured\nfor the specified project in the given region.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies",
"httpMethod": "GET",
"id": "compute.regionNetworkFirewallPolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies",
"response": {
"$ref": "FirewallPolicyList"
},
"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 firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"httpMethod": "PATCH",
"id": "compute.regionNetworkFirewallPolicies.patch",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}",
"request": {
"$ref": "FirewallPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"patchRule": {
"description": "Patches a rule of the specified priority.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.patchRule",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/patchRule",
"request": {
"$ref": "FirewallPolicyRule"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeAssociation": {
"description": "Removes an association for the specified network firewall policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.removeAssociation",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"name": {
"description": "Name for the association that will be removed.",
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeAssociation",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"removeRule": {
"description": "Deletes a rule of the specified priority.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.removeRule",
"parameterOrder": [
"project",
"region",
"firewallPolicy"
],
"parameters": {
"firewallPolicy": {
"description": "Name of the firewall 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"
},
"priority": {
"description": "The priority of the rule to remove from the firewall 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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/firewallPolicies/{firewallPolicy}/removeRule",
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.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": "projects/{project}/regions/{region}/firewallPolicies/{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.",
"flatPath": "projects/{project}/regions/{region}/firewallPolicies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionNetworkFirewallPolicies.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": "projects/{project}/regions/{region}/firewallPolicies/{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"
]
}
}
},
"regionNotificationEndpoints": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all NotificationEndpoint resources,\nregional and global, available to the specified project.",
"flatPath": "projects/{project}/aggregated/notificationEndpoints",
"httpMethod": "GET",
"id": "compute.regionNotificationEndpoints.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/notificationEndpoints",
"response": {
"$ref": "NotificationEndpointAggregatedList"
},
"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 NotificationEndpoint in the given region",
"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
"httpMethod": "DELETE",
"id": "compute.regionNotificationEndpoints.delete",
"parameterOrder": [
"project",
"region",
"notificationEndpoint"
],
"parameters": {
"notificationEndpoint": {
"description": "Name of the NotificationEndpoint 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified NotificationEndpoint resource in the given region.",
"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
"httpMethod": "GET",
"id": "compute.regionNotificationEndpoints.get",
"parameterOrder": [
"project",
"region",
"notificationEndpoint"
],
"parameters": {
"notificationEndpoint": {
"description": "Name of the NotificationEndpoint 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": "projects/{project}/regions/{region}/notificationEndpoints/{notificationEndpoint}",
"response": {
"$ref": "NotificationEndpoint"
},
"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 NotificationEndpoint in the specified project in the given region\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
"httpMethod": "POST",
"id": "compute.regionNotificationEndpoints.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/notificationEndpoints",
"request": {
"$ref": "NotificationEndpoint"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the NotificationEndpoints for a project in the given region.",
"flatPath": "projects/{project}/regions/{region}/notificationEndpoints",
"httpMethod": "GET",
"id": "compute.regionNotificationEndpoints.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/notificationEndpoints",
"response": {
"$ref": "NotificationEndpointList"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/notificationEndpoints/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionNotificationEndpoints.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": "projects/{project}/regions/{region}/notificationEndpoints/{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"
]
}
}
},
"regionOperations": {
"methods": {
"delete": {
"description": "Deletes the specified region-specific Operations resource.",
"flatPath": "projects/{project}/regions/{region}/operations/{operation}",
"httpMethod": "DELETE",
"id": "compute.regionOperations.delete",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete, or its unique numeric\nidentifier.",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/operations/{operation}",
"httpMethod": "GET",
"id": "compute.regionOperations.get",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/operations",
"httpMethod": "GET",
"id": "compute.regionOperations.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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`\nor for the request to approach the 2 minute deadline, and retrieves the\nspecified Operation resource. This method differs from the\n`GET` method in that it waits for no more than the default\ndeadline (2 minutes) and then returns the current state of the operation,\nwhich might be `DONE` or still in progress.\n\nThis method is called on a best-effort basis. Specifically:\n   \n   \n    - In uncommon cases, when the server is overloaded, the request might\n    return before the default deadline is reached, or might return after zero\n    seconds.\n   - If the default deadline is reached, there is no guarantee that the\n    operation is actually done when the method returns. Be prepared to retry\n    if the operation is not `DONE`.",
"flatPath": "projects/{project}/regions/{region}/operations/{operation}/wait",
"httpMethod": "POST",
"id": "compute.regionOperations.wait",
"parameterOrder": [
"project",
"region",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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"
]
}
}
},
"regionSecurityPolicies": {
"methods": {
"addRule": {
"description": "Inserts a rule into a security policy.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule",
"httpMethod": "POST",
"id": "compute.regionSecurityPolicies.addRule",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
"httpMethod": "DELETE",
"id": "compute.regionSecurityPolicies.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
"httpMethod": "GET",
"id": "compute.regionSecurityPolicies.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule",
"httpMethod": "GET",
"id": "compute.regionSecurityPolicies.getRule",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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": "projects/{project}/regions/{region}/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\nthe request.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies",
"httpMethod": "POST",
"id": "compute.regionSecurityPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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\nand region.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies",
"httpMethod": "GET",
"id": "compute.regionSecurityPolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
},
"patch": {
"description": "Patches the specified policy with the data included in the request. To\nclear fields in the policy, leave the fields empty and specify them in the\nupdateMask. This cannot be used to be update the rules in the policy.\nPlease use the per rule methods like addRule, patchRule, and removeRule\ninstead.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}",
"httpMethod": "PATCH",
"id": "compute.regionSecurityPolicies.patch",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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"
},
"updateMask": {
"description": "Indicates fields to be cleared as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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. To clear fields in the rule,\nleave the fields empty and specify them in the updateMask.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule",
"httpMethod": "POST",
"id": "compute.regionSecurityPolicies.patchRule",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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"
},
"updateMask": {
"description": "Indicates fields to be cleared as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule",
"httpMethod": "POST",
"id": "compute.regionSecurityPolicies.removeRule",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on a security policy. To learn more about labels,\nread the Labeling Resources\ndocumentation.",
"flatPath": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.regionSecurityPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/securityPolicies/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionSnapshotSettings": {
"methods": {
"get": {
"description": "Get region snapshot settings.",
"flatPath": "projects/{project}/regions/{region}/snapshotSettings",
"httpMethod": "GET",
"id": "compute.regionSnapshotSettings.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 for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/snapshotSettings",
"response": {
"$ref": "SnapshotSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patch region snapshot settings.",
"flatPath": "projects/{project}/regions/{region}/snapshotSettings",
"httpMethod": "PATCH",
"id": "compute.regionSnapshotSettings.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/snapshotSettings",
"request": {
"$ref": "SnapshotSettings"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionSnapshots": {
"methods": {
"delete": {
"description": "Deletes the specified Snapshot resource. Keep in mind that deleting\na single snapshot might not necessarily delete all the data on that\nsnapshot. If any data on the snapshot that is marked for deletion is\nneeded for subsequent snapshots, the data will be moved to the next\ncorresponding snapshot.\n\nFor more information, seeDeleting\nsnapshots.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}",
"httpMethod": "DELETE",
"id": "compute.regionSnapshots.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}",
"httpMethod": "GET",
"id": "compute.regionSnapshots.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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": "projects/{project}/regions/{region}/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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.regionSnapshots.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/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"
]
},
"insert": {
"description": "Creates a snapshot in the specified region using the data included\nin the request.",
"flatPath": "projects/{project}/regions/{region}/snapshots",
"httpMethod": "POST",
"id": "compute.regionSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/snapshots",
"request": {
"$ref": "Snapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of Snapshot resources contained within\nthe specified region.",
"flatPath": "projects/{project}/regions/{region}/snapshots",
"httpMethod": "GET",
"id": "compute.regionSnapshots.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.regionSnapshots.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": "projects/{project}/regions/{region}/snapshots/{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 a regional snapshot. To learn more about labels, read\nthe Labeling Resources\ndocumentation.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.regionSnapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/snapshots/{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.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.regionSnapshots.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": "projects/{project}/regions/{region}/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"
]
},
"updateKmsKey": {
"description": "Rotates the customer-managed\nencryption key to the latest version for the specified snapshot.",
"flatPath": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey",
"httpMethod": "POST",
"id": "compute.regionSnapshots.updateKmsKey",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"snapshot": {
"description": "Name of the snapshot resource to update. Should conform to RFC1035.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/snapshots/{snapshot}/updateKmsKey",
"request": {
"$ref": "RegionSnapshotUpdateKmsKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionSslCertificates": {
"methods": {
"delete": {
"description": "Deletes the specified SslCertificate resource in the region.",
"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\na list of available SSL certificates by making a list()\nrequest.",
"flatPath": "projects/{project}/regions/{region}/sslCertificates/{sslCertificate}",
"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": "projects/{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\nthe data included in the request",
"flatPath": "projects/{project}/regions/{region}/sslCertificates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject in the specified region.",
"flatPath": "projects/{project}/regions/{region}/sslCertificates",
"httpMethod": "GET",
"id": "compute.regionSslCertificates.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
}
}
},
"regionSslPolicies": {
"methods": {
"delete": {
"description": "Deletes the specified SSL policy. The SSL policy resource can be deleted\nonly if it is not in use by any TargetHttpsProxy or TargetSslProxy\nresources.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
"httpMethod": "DELETE",
"id": "compute.regionSslPolicies.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
"httpMethod": "GET",
"id": "compute.regionSslPolicies.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"sslPolicy": {
"description": "Name of the SSL policy to update. The name must be 1-63 characters long,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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": "Creates a new policy in the specified project and region using the data\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies",
"httpMethod": "POST",
"id": "compute.regionSslPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies",
"httpMethod": "GET",
"id": "compute.regionSslPolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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\ncustom profile.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies/listAvailableFeatures",
"httpMethod": "GET",
"id": "compute.regionSslPolicies.listAvailableFeatures",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
"httpMethod": "PATCH",
"id": "compute.regionSslPolicies.patch",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/sslPolicies/{sslPolicy}",
"request": {
"$ref": "SslPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"regionTargetHttpProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetHttpProxy resource.",
"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}",
"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": "projects/{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\nusing the data included in the request.",
"flatPath": "projects/{project}/regions/{region}/targetHttpProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nto the specified project in the specified region.",
"flatPath": "projects/{project}/regions/{region}/targetHttpProxies",
"httpMethod": "GET",
"id": "compute.regionTargetHttpProxies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"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": "projects/{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\nusing the data included in the request.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nto the specified project in the specified region.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies",
"httpMethod": "GET",
"id": "compute.regionTargetHttpsProxies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"patch": {
"description": "Patches the specified regional TargetHttpsProxy resource with the data\nincluded in the request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"httpMethod": "PATCH",
"id": "compute.regionTargetHttpsProxies.patch",
"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 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy 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": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}",
"request": {
"$ref": "TargetHttpsProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setSslCertificates": {
"description": "Replaces SslCertificates for TargetHttpsProxy.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set an\nSslCertificates 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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
}
}
},
"regionTargetTcpProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetTcpProxy resource.",
"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
"httpMethod": "DELETE",
"id": "compute.regionTargetTcpProxies.delete",
"parameterOrder": [
"project",
"region",
"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"
},
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/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.",
"flatPath": "projects/{project}/regions/{region}/targetTcpProxies/{targetTcpProxy}",
"httpMethod": "GET",
"id": "compute.regionTargetTcpProxies.get",
"parameterOrder": [
"project",
"region",
"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"
},
"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"
},
"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": "projects/{project}/regions/{region}/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 and region using\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/targetTcpProxies",
"httpMethod": "POST",
"id": "compute.regionTargetTcpProxies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/targetTcpProxies",
"request": {
"$ref": "TargetTcpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of TargetTcpProxy resources\navailable to the specified project in a given region.",
"flatPath": "projects/{project}/regions/{region}/targetTcpProxies",
"httpMethod": "GET",
"id": "compute.regionTargetTcpProxies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
}
}
},
"regionUrlMaps": {
"methods": {
"delete": {
"description": "Deletes the specified UrlMap resource.",
"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
"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\nRequest 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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/urlMaps",
"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\nRequest ID to support idempotency.",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject in the specified region.",
"flatPath": "projects/{project}/regions/{region}/urlMaps",
"httpMethod": "GET",
"id": "compute.regionUrlMaps.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
"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\nRequest 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": "projects/{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\nrequest.",
"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}",
"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\nRequest 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": "projects/{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\nprovided UrlMap will be run. Calling this method does NOT create the\nUrlMap.",
"flatPath": "projects/{project}/regions/{region}/urlMaps/{urlMap}/validate",
"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": "projects/{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"
]
}
}
},
"regionZones": {
"methods": {
"list": {
"description": "Retrieves the list of Zone resources under the specific region available to\nthe specified project.",
"flatPath": "projects/{project}/regions/{region}/zones",
"httpMethod": "GET",
"id": "compute.regionZones.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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": "Region for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/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"
]
}
}
},
"regions": {
"methods": {
"get": {
"description": "Returns the specified Region resource.\n\nTo decrease latency for this method, you can optionally omit any unneeded\ninformation from the response by using a field mask. This practice is\nespecially recommended for unused quota information (the `quotas` field).\nTo exclude one or more fields, set your request's `fields` query parameter\nto only include the fields you need. For example, to only include the `id`\nand `selfLink` fields, add the query parameter `?fields=id,selfLink` to\nyour request.\n\nThis method fails if the quota information is unavailable for the region\nand if the organization policy constraint\ncompute.requireBasicQuotaInResponse is enforced. This\nconstraint, when enforced, disables the fail-open behaviour when quota\ninformation (the `items.quotas` field) is unavailable for the region.\nIt is recommended to use the default setting\nfor the constraint unless your application requires the fail-closed\nbehaviour for this method.",
"flatPath": "projects/{project}/regions/{region}",
"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": "projects/{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.\n\nTo decrease latency for this method, you can optionally omit any unneeded\ninformation from the response by using a field mask. This practice is\nespecially recommended for unused quota information\n(the `items.quotas` field).\nTo exclude one or more fields, set your request's `fields` query parameter\nto only include the fields you need. For example, to only include the `id`\nand `selfLink` fields, add the query parameter `?fields=id,selfLink` to\nyour request.\n\nThis method fails if the quota information is unavailable for the region\nand if the organization policy constraint\ncompute.requireBasicQuotaInResponse is enforced. This\nconstraint, when enforced, disables the fail-open behaviour when quota\ninformation (the `items.quotas` field) is unavailable for the region.\nIt is recommended to use the default setting\nfor the constraint unless your application requires the fail-closed\nbehaviour for this method.",
"flatPath": "projects/{project}/regions",
"httpMethod": "GET",
"id": "compute.regions.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
}
}
},
"reservationBlocks": {
"methods": {
"get": {
"description": "Retrieves information about the specified reservation block.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}",
"httpMethod": "GET",
"id": "compute.reservationBlocks.get",
"parameterOrder": [
"project",
"zone",
"reservation",
"reservationBlock"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"reservation": {
"description": "The name of the reservation.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"reservationBlock": {
"description": "The name of the reservation block.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"view": {
"description": "View of the Block.",
"enum": [
"BASIC",
"BLOCK_VIEW_UNSPECIFIED",
"FULL"
],
"enumDescriptions": [
"This view includes basic information about the reservation block",
"The default / unset value. The API will default to the BASIC view.",
"Includes detailed topology view."
],
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}",
"response": {
"$ref": "ReservationBlocksGetResponse"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.reservationBlocks.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{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 a list of reservation blocks under a single reservation.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks",
"httpMethod": "GET",
"id": "compute.reservationBlocks.list",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"reservation": {
"description": "The name of the reservation.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks",
"response": {
"$ref": "ReservationBlocksListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"performMaintenance": {
"description": "Allows customers to perform maintenance on a reservation block",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance",
"httpMethod": "POST",
"id": "compute.reservationBlocks.performMaintenance",
"parameterOrder": [
"project",
"zone",
"reservation",
"reservationBlock"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservation": {
"description": "The name of the reservation.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"reservationBlock": {
"description": "The name of the reservation block.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/reservations/{reservation}/reservationBlocks/{reservationBlock}/performMaintenance",
"request": {
"$ref": "ReservationsBlocksPerformMaintenanceRequest"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.reservationBlocks.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetNestedPolicyRequest"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.reservationBlocks.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/reservations/{parentResource}/reservationBlocks/{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"
]
}
}
},
"reservationSlots": {
"methods": {
"get": {
"description": "Retrieves information about the specified reservation slot.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}",
"httpMethod": "GET",
"id": "compute.reservationSlots.get",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSlot"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}",
"location": "path",
"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([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",
"required": true,
"type": "string"
},
"reservationSlot": {
"description": "The name of the reservation slot, formatted as RFC1035 or a resource ID\nnumber.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "The name of the zone for this request, formatted as RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}",
"response": {
"$ref": "ReservationSlotsGetResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"getVersion": {
"description": "Allows customers to get SBOM versions of a reservation slot.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion",
"httpMethod": "POST",
"id": "compute.reservationSlots.getVersion",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSlot"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}",
"location": "path",
"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([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",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservationSlot": {
"description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getVersion",
"request": {
"$ref": "ReservationSlotsGetVersionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of reservation slots under a single reservation.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots",
"httpMethod": "GET",
"id": "compute.reservationSlots.list",
"parameterOrder": [
"project",
"zone",
"parentName"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentName": {
"description": "The name of the parent reservation and parent block, formatted as\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}",
"location": "path",
"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([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",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "The name of the zone for this request, formatted as RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots",
"response": {
"$ref": "ReservationSlotsListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Update a reservation slot in the specified sub-block.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}",
"httpMethod": "POST",
"id": "compute.reservationSlots.update",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSlot"
],
"parameters": {
"parentName": {
"description": "The name of the sub-block resource.",
"location": "path",
"pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([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",
"required": true,
"type": "string"
},
"reservationSlot": {
"description": "The name of the slot resource.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"zone": {
"description": "The name of the zone for this request, formatted as RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}",
"request": {
"$ref": "ReservationSlot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"reservationSubBlocks": {
"methods": {
"get": {
"description": "Retrieves information about the specified reservation subBlock.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}",
"httpMethod": "GET",
"id": "compute.reservationSubBlocks.get",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSubBlock"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
"location": "path",
"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"reservationSubBlock": {
"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"view": {
"description": "View of the subBlock.",
"enum": [
"SUB_BLOCK_VIEW_BASIC",
"SUB_BLOCK_VIEW_FULL",
"SUB_BLOCK_VIEW_UNSPECIFIED"
],
"enumDescriptions": [
"This view includes basic information about the reservation sub block",
"Includes detailed topology view.",
"The default / unset value. The API will default to the BASIC view."
],
"location": "query",
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}",
"response": {
"$ref": "ReservationSubBlocksGetResponse"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.reservationSubBlocks.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"format": "int32",
"location": "query",
"type": "integer"
},
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{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"
]
},
"getVersion": {
"description": "Allows customers to get SBOM versions of a reservation subBlock.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/getVersion",
"httpMethod": "POST",
"id": "compute.reservationSubBlocks.getVersion",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSubBlock"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
"location": "path",
"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservationSubBlock": {
"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/getVersion",
"request": {
"$ref": "ReservationSubBlocksGetVersionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of reservation subBlocks under a single reservation.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks",
"httpMethod": "GET",
"id": "compute.reservationSubBlocks.list",
"parameterOrder": [
"project",
"zone",
"parentName"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
"location": "path",
"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks",
"response": {
"$ref": "ReservationSubBlocksListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"performMaintenance": {
"description": "Allows customers to perform maintenance on a reservation subBlock",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/performMaintenance",
"httpMethod": "POST",
"id": "compute.reservationSubBlocks.performMaintenance",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSubBlock"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
"location": "path",
"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservationSubBlock": {
"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/performMaintenance",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"reportFaulty": {
"description": "Allows customers to report a faulty subBlock.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlock}/reportFaulty",
"httpMethod": "POST",
"id": "compute.reservationSubBlocks.reportFaulty",
"parameterOrder": [
"project",
"zone",
"parentName",
"reservationSubBlock"
],
"parameters": {
"parentName": {
"description": "The name of the parent reservation and parent block. In the format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}",
"location": "path",
"pattern": "^reservations/[^/]+/reservationBlocks/[^/]+$",
"required": true,
"type": "string"
},
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservationSubBlock": {
"description": "The name of the reservation subBlock.\nName should conform to RFC1035 or be a resource ID.",
"location": "path",
"required": true,
"type": "string"
},
"zone": {
"description": "Name of the zone for this request. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/{+parentName}/reservationSubBlocks/{reservationSubBlock}/reportFaulty",
"request": {
"$ref": "ReservationSubBlocksReportFaultyRequest"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.reservationSubBlocks.setIamPolicy",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{resource}/setIamPolicy",
"request": {
"$ref": "ZoneSetNestedPolicyRequest"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.reservationSubBlocks.testIamPermissions",
"parameterOrder": [
"project",
"zone",
"parentResource",
"resource"
],
"parameters": {
"parentResource": {
"description": "Name or id of parent resource of the resource for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-zA-Z0-9/]{0,255}[a-zA-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"
},
"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": "projects/{project}/zones/{zone}/{+parentResource}/reservationSubBlocks/{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"
]
}
}
},
"reservations": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of reservations.\n\nTo prevent failure, it is recommended that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/reservations",
"httpMethod": "GET",
"id": "compute.reservations.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.reservations.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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, readReserving zonal\nresources.",
"flatPath": "projects/{project}/zones/{zone}/reservations",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nspecified project in specified zone.",
"flatPath": "projects/{project}/zones/{zone}/reservations",
"httpMethod": "GET",
"id": "compute.reservations.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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"
]
},
"performMaintenance": {
"description": "Perform maintenance on an extended reservation",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance",
"httpMethod": "POST",
"id": "compute.reservations.performMaintenance",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"project": {
"description": "Project ID for this request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"reservation": {
"description": "The name of the reservation.\nName should conform to RFC1035 or be a resource ID.",
"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. Zone name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/reservations/{reservation}/performMaintenance",
"request": {
"$ref": "ReservationsPerformMaintenanceRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"resize": {
"description": "Resizes the reservation (applicable to standalone reservations only). For\nmore information, readModifying\nreservations.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}/resize",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{resource}/testIamPermissions",
"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": "projects/{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"
]
},
"update": {
"description": "Update share settings of the reservation.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservation}",
"httpMethod": "PATCH",
"id": "compute.reservations.update",
"parameterOrder": [
"project",
"zone",
"reservation"
],
"parameters": {
"paths": {
"location": "query",
"repeated": 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"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": "projects/{project}/zones/{zone}/reservations/{reservation}",
"request": {
"$ref": "Reservation"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"resourcePolicies": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of resource policies.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/resourcePolicies",
"httpMethod": "GET",
"id": "compute.resourcePolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.resourcePolicies.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nspecified project in specified region.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies",
"httpMethod": "GET",
"id": "compute.resourcePolicies.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"patch": {
"description": "Modify the specified resource policy.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"httpMethod": "PATCH",
"id": "compute.resourcePolicies.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"resourcePolicy": {
"description": "Id of the resource policy 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"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/resourcePolicies/{resourcePolicy}",
"request": {
"$ref": "ResourcePolicy"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/setIamPolicy",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/resourcePolicies/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"rolloutPlans": {
"methods": {
"delete": {
"description": "Deletes a RolloutPlan.",
"flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
"httpMethod": "DELETE",
"id": "compute.rolloutPlans.delete",
"parameterOrder": [
"project",
"rolloutPlan"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"rolloutPlan": {
"description": "Name of the RolloutPlan 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": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Gets details of a single project-scoped RolloutPlan.",
"flatPath": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
"httpMethod": "GET",
"id": "compute.rolloutPlans.get",
"parameterOrder": [
"project",
"rolloutPlan"
],
"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"
},
"rolloutPlan": {
"description": "Name of the persistent rollout plan 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": "projects/{project}/global/rolloutPlans/{rolloutPlan}",
"response": {
"$ref": "RolloutPlan"
},
"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 RolloutPlan in a given project and location.",
"flatPath": "projects/{project}/global/rolloutPlans",
"httpMethod": "POST",
"id": "compute.rolloutPlans.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/rolloutPlans",
"request": {
"$ref": "RolloutPlan"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists RolloutPlans in a given project and location.",
"flatPath": "projects/{project}/global/rolloutPlans",
"httpMethod": "GET",
"id": "compute.rolloutPlans.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/rolloutPlans",
"response": {
"$ref": "RolloutPlansListResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"rollouts": {
"methods": {
"cancel": {
"description": "Cancels a Rollout.",
"flatPath": "projects/{project}/global/rollouts/{rollout}",
"httpMethod": "PATCH",
"id": "compute.rollouts.cancel",
"parameterOrder": [
"project",
"rollout"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"rollback": {
"description": "Optional. If true, then the ongoing rollout must be rolled back. Else, just cancel\nthe rollout without taking any further actions. Note that products must\nsupport at least one of these options, however, it does not need to support\nboth.",
"location": "query",
"type": "boolean"
},
"rollout": {
"description": "Name of the Rollout resource to cancel.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/rollouts/{rollout}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"delete": {
"description": "Deletes a Rollout.",
"flatPath": "projects/{project}/global/rollouts/{rollout}",
"httpMethod": "DELETE",
"id": "compute.rollouts.delete",
"parameterOrder": [
"project",
"rollout"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"rollout": {
"description": "Name of the Rollout 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": "projects/{project}/global/rollouts/{rollout}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Gets details of a single project-scoped Rollout.",
"flatPath": "projects/{project}/global/rollouts/{rollout}",
"httpMethod": "GET",
"id": "compute.rollouts.get",
"parameterOrder": [
"project",
"rollout"
],
"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"
},
"rollout": {
"description": "Name of the persistent rollout 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": "projects/{project}/global/rollouts/{rollout}",
"response": {
"$ref": "Rollout"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"list": {
"description": "Lists Rollouts in a given project and location.",
"flatPath": "projects/{project}/global/rollouts",
"httpMethod": "GET",
"id": "compute.rollouts.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/rollouts",
"response": {
"$ref": "RolloutsListResponse"
},
"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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/routers",
"httpMethod": "GET",
"id": "compute.routers.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/routers/{router}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"deleteRoutePolicy": {
"description": "Deletes Route Policy",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy",
"httpMethod": "POST",
"id": "compute.routers.deleteRoutePolicy",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"policy": {
"description": "The Policy name for this request. Name must conform to RFC1035",
"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"
},
"requestId": {
"description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource where Route Policy is defined.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/deleteRoutePolicy",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified Router resource.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}",
"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": "projects/{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"
]
},
"getNatIpInfo": {
"description": "Retrieves runtime NAT IP information.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo",
"httpMethod": "GET",
"id": "compute.routers.getNatIpInfo",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"natName": {
"description": "Name of the nat service to filter the NAT IP information.\nIf it is omitted, all nats for this router will be returned.\nName should conform to RFC1035.",
"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 IP information. The name\nshould conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/getNatIpInfo",
"response": {
"$ref": "NatIpInfoResponse"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/getNatMappingInfo",
"httpMethod": "GET",
"id": "compute.routers.getNatMappingInfo",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
"format": "uint32",
"location": "query",
"minimum": "0",
"type": "integer"
},
"natName": {
"description": "Name of the nat service to filter the Nat Mapping information.\nIf it is omitted, all nats for this router will be returned.\nName should conform to RFC1035.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"router": {
"description": "Name of the Router resource to query for Nat Mapping information of\nVM 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": "projects/{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"
]
},
"getRoutePolicy": {
"description": "Returns specified Route Policy",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy",
"httpMethod": "GET",
"id": "compute.routers.getRoutePolicy",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"policy": {
"description": "The Policy name for this request. Name must conform to RFC1035",
"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 the route policy. The name should\nconform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/getRoutePolicy",
"response": {
"$ref": "RoutersGetRoutePolicyResponse"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/getRouterStatus",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/routers",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/routers",
"httpMethod": "GET",
"id": "compute.routers.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"listBgpRoutes": {
"description": "Retrieves a list of router bgp routes available to the specified project.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes",
"httpMethod": "GET",
"id": "compute.routers.listBgpRoutes",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"addressFamily": {
"default": "UNSPECIFIED_IP_VERSION",
"description": "(Required) limit results to this address family (either IPv4 or IPv6)",
"enum": [
"IPV4",
"IPV6",
"UNSPECIFIED_IP_VERSION"
],
"enumDescriptions": [
"",
"",
""
],
"location": "query",
"type": "string"
},
"destinationPrefix": {
"description": "Limit results to destinations that are subnets of this CIDR range",
"location": "query",
"type": "string"
},
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
"location": "query",
"type": "string"
},
"peer": {
"description": "(Required) limit results to the BGP peer with the given name.\nName should conform to RFC1035.",
"location": "query",
"type": "string"
},
"policyApplied": {
"default": "true",
"description": "When true, the method returns post-policy routes. Otherwise, it returns\npre-policy routes.",
"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"
},
"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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"routeType": {
"default": "UNSPECIFIED_ROUTE_TYPE",
"description": "(Required) limit results to this type of route (either LEARNED or\nADVERTISED)",
"enum": [
"ADVERTISED",
"LEARNED",
"UNSPECIFIED_ROUTE_TYPE"
],
"enumDescriptions": [
"",
"",
""
],
"location": "query",
"type": "string"
},
"router": {
"description": "Name or id of the resource for this request.\nName should conform to RFC1035.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/listBgpRoutes",
"response": {
"$ref": "RoutersListBgpRoutes"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listRoutePolicies": {
"description": "Retrieves a list of router route policy subresources available to the\nspecified project.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies",
"httpMethod": "GET",
"id": "compute.routers.listRoutePolicies",
"parameterOrder": [
"project",
"region",
"router"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"router": {
"description": "Name or id of the resource for this request.\nName should conform to RFC1035.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/listRoutePolicies",
"response": {
"$ref": "RoutersListRoutePolicies"
},
"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\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"patchRoutePolicy": {
"description": "Patches Route Policy",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy",
"httpMethod": "POST",
"id": "compute.routers.patchRoutePolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource where Route Policy is defined.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/patchRoutePolicy",
"request": {
"$ref": "RoutePolicy"
},
"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 andupdate operations.\nCalling this method does NOT create or update the router.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/preview",
"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": "projects/{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\nrequest.  This method conforms toPUT semantics, which requests that the state of the\ntarget resource be created or replaced with the state defined by the\nrepresentation enclosed in the request message payload.",
"flatPath": "projects/{project}/regions/{region}/routers/{router}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"updateRoutePolicy": {
"description": "Updates or creates new Route Policy",
"flatPath": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy",
"httpMethod": "POST",
"id": "compute.routers.updateRoutePolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"router": {
"description": "Name of the Router resource where Route Policy is defined.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/routers/{router}/updateRoutePolicy",
"request": {
"$ref": "RoutePolicy"
},
"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.",
"flatPath": "projects/{project}/global/routes/{route}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/routes/{route}",
"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": "projects/{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\nin the request.",
"flatPath": "projects/{project}/global/routes",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/routes",
"httpMethod": "GET",
"id": "compute.routes.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/global/routes/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.routes.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": "projects/{project}/global/routes/{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"
]
}
}
},
"securityPolicies": {
"methods": {
"addRule": {
"description": "Inserts a rule into a security policy.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/addRule",
"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"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"aggregatedList": {
"description": "Retrieves the list of all SecurityPolicy resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/securityPolicies",
"httpMethod": "GET",
"id": "compute.securityPolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/securityPolicies",
"response": {
"$ref": "SecurityPoliciesAggregatedList"
},
"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 policy.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/getRule",
"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": "projects/{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\nthe request.",
"flatPath": "projects/{project}/global/securityPolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/securityPolicies",
"httpMethod": "GET",
"id": "compute.securityPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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)\nexpressions.",
"flatPath": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
"httpMethod": "GET",
"id": "compute.securityPolicies.listPreconfiguredExpressionSets",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/securityPolicies/listPreconfiguredExpressionSets",
"response": {
"$ref": "SecurityPoliciesListPreconfiguredExpressionSetsResponse"
},
"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 policy with the data included in the request. To\nclear fields in the policy, leave the fields empty and specify them in the\nupdateMask. This cannot be used to be update the rules in the policy.\nPlease use the per rule methods like addRule, patchRule, and removeRule\ninstead.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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"
},
"updateMask": {
"description": "Indicates fields to be cleared as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{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. To clear fields in the rule,\nleave the fields empty and specify them in the updateMask.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/patchRule",
"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"
},
"updateMask": {
"description": "Indicates fields to be cleared as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "If true, the request will not be committed.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
"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": "projects/{project}/global/securityPolicies/{securityPolicy}/removeRule",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setLabels": {
"description": "Sets the labels on a security policy. To learn more about labels,\nread the Labeling Resources\ndocumentation.",
"flatPath": "projects/{project}/global/securityPolicies/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.securityPolicies.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": "projects/{project}/global/securityPolicies/{resource}/setLabels",
"request": {
"$ref": "GlobalSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"serviceAttachments": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all ServiceAttachment resources,\nregional and global, available to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/serviceAttachments",
"httpMethod": "GET",
"id": "compute.serviceAttachments.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/serviceAttachments",
"response": {
"$ref": "ServiceAttachmentAggregatedList"
},
"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 ServiceAttachment in the given scope",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"httpMethod": "DELETE",
"id": "compute.serviceAttachments.delete",
"parameterOrder": [
"project",
"region",
"serviceAttachment"
],
"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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"serviceAttachment": {
"description": "Name of the ServiceAttachment 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": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified ServiceAttachment resource in the given scope.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"httpMethod": "GET",
"id": "compute.serviceAttachments.get",
"parameterOrder": [
"project",
"region",
"serviceAttachment"
],
"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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"serviceAttachment": {
"description": "Name of the ServiceAttachment 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"
},
"showNatIps": {
"description": "Indicates whether NAT IPs should be included in the response.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"response": {
"$ref": "ServiceAttachment"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.serviceAttachments.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{project}/regions/{region}/serviceAttachments/{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 ServiceAttachment in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments",
"httpMethod": "POST",
"id": "compute.serviceAttachments.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 of 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/serviceAttachments",
"request": {
"$ref": "ServiceAttachment"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the ServiceAttachments for a project in the given scope.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments",
"httpMethod": "GET",
"id": "compute.serviceAttachments.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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 of this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/regions/{region}/serviceAttachments",
"response": {
"$ref": "ServiceAttachmentList"
},
"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 ServiceAttachment resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"httpMethod": "PATCH",
"id": "compute.serviceAttachments.patch",
"parameterOrder": [
"project",
"region",
"serviceAttachment"
],
"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 scoping this request and 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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"serviceAttachment": {
"description": "The resource id of the ServiceAttachment to patch. It should conform to\nRFC1035 resource name or be a string form on an unsigned long number.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/serviceAttachments/{serviceAttachment}",
"request": {
"$ref": "ServiceAttachment"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.serviceAttachments.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": "projects/{project}/regions/{region}/serviceAttachments/{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.",
"flatPath": "projects/{project}/regions/{region}/serviceAttachments/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.serviceAttachments.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": "projects/{project}/regions/{region}/serviceAttachments/{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"
]
}
}
},
"snapshotSettings": {
"methods": {
"get": {
"description": "Get snapshot settings.",
"flatPath": "projects/{project}/global/snapshotSettings",
"httpMethod": "GET",
"id": "compute.snapshotSettings.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": "projects/{project}/global/snapshotSettings",
"response": {
"$ref": "SnapshotSettings"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"patch": {
"description": "Patch snapshot settings.",
"flatPath": "projects/{project}/global/snapshotSettings",
"httpMethod": "PATCH",
"id": "compute.snapshotSettings.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/snapshotSettings",
"request": {
"$ref": "SnapshotSettings"
},
"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\na single snapshot might not necessarily delete all the data on that\nsnapshot. If any data on the snapshot that is marked for deletion is\nneeded for subsequent snapshots, the data will be moved to the next\ncorresponding snapshot.\n\nFor more information, seeDeleting\nsnapshots.",
"flatPath": "projects/{project}/global/snapshots/{snapshot}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/snapshots/{snapshot}",
"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": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.snapshots.getIamPolicy",
"parameterOrder": [
"project",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{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"
]
},
"insert": {
"description": "Creates a snapshot in the specified project using the data included\nin the request. For regular snapshot creation, consider using this method\ninstead of disks.createSnapshot,\nas this method supports more features, such as creating snapshots in a\nproject different from the source disk project.",
"flatPath": "projects/{project}/global/snapshots",
"httpMethod": "POST",
"id": "compute.snapshots.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/snapshots",
"request": {
"$ref": "Snapshot"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves the list of Snapshot resources contained within\nthe specified project.",
"flatPath": "projects/{project}/global/snapshots",
"httpMethod": "GET",
"id": "compute.snapshots.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/global/snapshots/{resource}/setIamPolicy",
"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": "projects/{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 theLabeling\nResources documentation.",
"flatPath": "projects/{project}/global/snapshots/{resource}/setLabels",
"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": "projects/{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.",
"flatPath": "projects/{project}/global/snapshots/{resource}/testIamPermissions",
"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": "projects/{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"
]
},
"updateKmsKey": {
"description": "Rotates the customer-managed\nencryption key to the latest version for the specified snapshot.",
"flatPath": "projects/{project}/global/snapshots/{snapshot}/updateKmsKey",
"httpMethod": "POST",
"id": "compute.snapshots.updateKmsKey",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"snapshot": {
"description": "Name of the snapshot resource to update. Should conform to RFC1035.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/snapshots/{snapshot}/updateKmsKey",
"request": {
"$ref": "SnapshotUpdateKmsKeyRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"sslCertificates": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all SslCertificate resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/sslCertificates",
"httpMethod": "GET",
"id": "compute.sslCertificates.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/sslCertificates/{sslCertificate}",
"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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/global/sslCertificates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/sslCertificates",
"httpMethod": "GET",
"id": "compute.sslCertificates.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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": {
"aggregatedList": {
"description": "Retrieves the list of all SslPolicy resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/sslPolicies",
"httpMethod": "GET",
"id": "compute.sslPolicies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/sslPolicies",
"response": {
"$ref": "SslPoliciesAggregatedList"
},
"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 SSL policy. The SSL policy resource can be deleted\nonly if it is not in use by any TargetHttpsProxy or TargetSslProxy\nresources.",
"flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
"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,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/sslPolicies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/sslPolicies",
"httpMethod": "GET",
"id": "compute.sslPolicies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\ncustom profile.",
"flatPath": "projects/{project}/global/sslPolicies/listAvailableFeatures",
"httpMethod": "GET",
"id": "compute.sslPolicies.listAvailableFeatures",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/sslPolicies/{sslPolicy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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,\nand comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/sslPolicies/{sslPolicy}",
"request": {
"$ref": "SslPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"storagePoolTypes": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of storage pool types.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/storagePoolTypes",
"httpMethod": "GET",
"id": "compute.storagePoolTypes.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/storagePoolTypes",
"response": {
"$ref": "StoragePoolTypeAggregatedList"
},
"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 storage pool type.",
"flatPath": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}",
"httpMethod": "GET",
"id": "compute.storagePoolTypes.get",
"parameterOrder": [
"project",
"zone",
"storagePoolType"
],
"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"
},
"storagePoolType": {
"description": "Name of the storage pool 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"
},
"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": "projects/{project}/zones/{zone}/storagePoolTypes/{storagePoolType}",
"response": {
"$ref": "StoragePoolType"
},
"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 storage pool types available to the specified\nproject.",
"flatPath": "projects/{project}/zones/{zone}/storagePoolTypes",
"httpMethod": "GET",
"id": "compute.storagePoolTypes.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{project}/zones/{zone}/storagePoolTypes",
"response": {
"$ref": "StoragePoolTypeList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
}
}
},
"storagePools": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of storage pools.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/storagePools",
"httpMethod": "GET",
"id": "compute.storagePools.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/storagePools",
"response": {
"$ref": "StoragePoolAggregatedList"
},
"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 storage pool. Deleting a storagePool\nremoves its data permanently and is irreversible. However, deleting a\nstoragePool does not delete any snapshots previously\nmade from the storagePool. You must separately delete\nsnapshots.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"httpMethod": "DELETE",
"id": "compute.storagePools.delete",
"parameterOrder": [
"project",
"zone",
"storagePool"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"storagePool": {
"description": "Name of the storage pool 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": "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": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns a specified storage pool. Gets a list of available\nstorage pools by making a list() request.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"httpMethod": "GET",
"id": "compute.storagePools.get",
"parameterOrder": [
"project",
"zone",
"storagePool"
],
"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"
},
"storagePool": {
"description": "Name of the storage pool 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": "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": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"response": {
"$ref": "StoragePool"
},
"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\npolicy or resource exists.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.storagePools.getIamPolicy",
"parameterOrder": [
"project",
"zone",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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"
},
"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": "projects/{project}/zones/{zone}/storagePools/{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 storage pool in the specified project using the data\nin the request.",
"flatPath": "projects/{project}/zones/{zone}/storagePools",
"httpMethod": "POST",
"id": "compute.storagePools.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/storagePools",
"request": {
"$ref": "StoragePool"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Retrieves a list of storage pools contained within\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/storagePools",
"httpMethod": "GET",
"id": "compute.storagePools.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{project}/zones/{zone}/storagePools",
"response": {
"$ref": "StoragePoolList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"listDisks": {
"description": "Lists the disks in a specified storage pool.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks",
"httpMethod": "GET",
"id": "compute.storagePools.listDisks",
"parameterOrder": [
"project",
"zone",
"storagePool"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"storagePool": {
"description": "Name of the storage pool to list disks of.",
"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": "projects/{project}/zones/{zone}/storagePools/{storagePool}/listDisks",
"response": {
"$ref": "StoragePoolListDisks"
},
"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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/setIamPolicy",
"httpMethod": "POST",
"id": "compute.storagePools.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": "projects/{project}/zones/{zone}/storagePools/{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.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.storagePools.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": "projects/{project}/zones/{zone}/storagePools/{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 the specified storagePool with the data included in the request.\nThe update is performed only on selected fields included as part\nof update-mask. Only the following fields can be modified:\npool_provisioned_capacity_gb, pool_provisioned_iops and\npool_provisioned_throughput.",
"flatPath": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"httpMethod": "PATCH",
"id": "compute.storagePools.update",
"parameterOrder": [
"project",
"zone",
"storagePool"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"storagePool": {
"description": "The storagePool 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"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"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": "projects/{project}/zones/{zone}/storagePools/{storagePool}",
"request": {
"$ref": "StoragePool"
},
"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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/subnetworks",
"httpMethod": "GET",
"id": "compute.subnetworks.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
},
"views": {
"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
"enum": [
"DEFAULT",
"WITH_UTILIZATION"
],
"enumDescriptions": [
"",
"Utilization data is included in the response."
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/expandIpCidrRange",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
"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"
},
"views": {
"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
"enum": [
"DEFAULT",
"WITH_UTILIZATION"
],
"enumDescriptions": [
"",
"Utilization data is included in the response."
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "projects/{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\npolicy or resource exists.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/getIamPolicy",
"httpMethod": "GET",
"id": "compute.subnetworks.getIamPolicy",
"parameterOrder": [
"project",
"region",
"resource"
],
"parameters": {
"optionsRequestedPolicyVersion": {
"description": "Requested IAM Policy version.",
"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": "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": "projects/{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\nincluded in the request.",
"flatPath": "projects/{project}/regions/{region}/subnetworks",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject.",
"flatPath": "projects/{project}/regions/{region}/subnetworks",
"httpMethod": "GET",
"id": "compute.subnetworks.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"views": {
"description": "Defines the extra views returned back in the subnetwork resource.\nSupported values:\n   \n   - WITH_UTILIZATION: Utilization data is included in the\n   response.",
"enum": [
"DEFAULT",
"WITH_UTILIZATION"
],
"enumDescriptions": [
"",
"Utilization data is included in the response."
],
"location": "query",
"repeated": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/aggregated/subnetworks/listUsable",
"httpMethod": "GET",
"id": "compute.subnetworks.listUsable",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProject": {
"description": "The project id or project number in which the subnetwork is intended to be\nused. Only applied for Shared VPC. See [Shared VPC\ndocumentation](https://cloud.google.com/vpc/docs/shared-vpc/)",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.\nOnly certain fields can be updated with a patch request\nas indicated in the field descriptions.\nYou must specify the current fingerprint of the\nsubnetwork resource being patched.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}",
"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\ntime allowed to drain connections from the current ACTIVE subnetwork\nto the current BACKUP subnetwork. The drain timeout is only applicable\nwhen the following conditions are true:\n - the subnetwork being patched has purpose = INTERNAL_HTTPS_LOAD_BALANCER\n - the subnetwork being patched has role = BACKUP\n - the patch request is setting the role to ACTIVE. Note that after this\n   patch operation the roles of the ACTIVE and BACKUP subnetworks will be\n   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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\nReplaces any existing policy.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/setIamPolicy",
"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": "projects/{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\nexternal IP addresses through Private Google Access.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{subnetwork}/setPrivateIpGoogleAccess",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/subnetworks/{resource}/testIamPermissions",
"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": "projects/{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"
]
}
}
},
"targetGrpcProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetGrpcProxy in the given scope",
"flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"httpMethod": "DELETE",
"id": "compute.targetGrpcProxies.delete",
"parameterOrder": [
"project",
"targetGrpcProxy"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetGrpcProxy": {
"description": "Name of the TargetGrpcProxy 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": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Returns the specified TargetGrpcProxy resource in the given scope.",
"flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"httpMethod": "GET",
"id": "compute.targetGrpcProxies.get",
"parameterOrder": [
"project",
"targetGrpcProxy"
],
"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"
},
"targetGrpcProxy": {
"description": "Name of the TargetGrpcProxy 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": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"response": {
"$ref": "TargetGrpcProxy"
},
"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 TargetGrpcProxy in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/global/targetGrpcProxies",
"httpMethod": "POST",
"id": "compute.targetGrpcProxies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/global/targetGrpcProxies",
"request": {
"$ref": "TargetGrpcProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the TargetGrpcProxies for a project in the given scope.",
"flatPath": "projects/{project}/global/targetGrpcProxies",
"httpMethod": "GET",
"id": "compute.targetGrpcProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/targetGrpcProxies",
"response": {
"$ref": "TargetGrpcProxyList"
},
"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 TargetGrpcProxy resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"httpMethod": "PATCH",
"id": "compute.targetGrpcProxies.patch",
"parameterOrder": [
"project",
"targetGrpcProxy"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetGrpcProxy": {
"description": "Name of the TargetGrpcProxy 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": "projects/{project}/global/targetGrpcProxies/{targetGrpcProxy}",
"request": {
"$ref": "TargetGrpcProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"targetHttpProxies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all TargetHttpProxy resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetHttpProxies",
"httpMethod": "GET",
"id": "compute.targetHttpProxies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
"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": "projects/{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\nproject using the data included in the request.",
"flatPath": "projects/{project}/global/targetHttpProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nto the specified project.",
"flatPath": "projects/{project}/global/targetHttpProxies",
"httpMethod": "GET",
"id": "compute.targetHttpProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"patch": {
"description": "Patches the specified TargetHttpProxy resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
"httpMethod": "PATCH",
"id": "compute.targetHttpProxies.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpProxy": {
"description": "Name of the TargetHttpProxy 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": "projects/{project}/global/targetHttpProxies/{targetHttpProxy}",
"request": {
"$ref": "TargetHttpProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setUrlMap": {
"description": "Changes the URL map for TargetHttpProxy.",
"flatPath": "projects/{project}/targetHttpProxies/{targetHttpProxy}/setUrlMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetHttpsProxies",
"httpMethod": "GET",
"id": "compute.targetHttpsProxies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"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": "projects/{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\nproject using the data included in the request.",
"flatPath": "projects/{project}/global/targetHttpsProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\navailable to the specified project.",
"flatPath": "projects/{project}/global/targetHttpsProxies",
"httpMethod": "GET",
"id": "compute.targetHttpsProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"patch": {
"description": "Patches the specified TargetHttpsProxy resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"httpMethod": "PATCH",
"id": "compute.targetHttpsProxies.patch",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy 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": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}",
"request": {
"$ref": "TargetHttpsProxy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setCertificateMap": {
"description": "Changes the Certificate Map for TargetHttpsProxy.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
"httpMethod": "POST",
"id": "compute.targetHttpsProxies.setCertificateMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource whose CertificateMap is\nto be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setCertificateMap",
"request": {
"$ref": "TargetHttpsProxiesSetCertificateMapRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setQuicOverride": {
"description": "Sets the QUIC override policy for TargetHttpsProxy.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setQuicOverride",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set the QUIC override policy for.\nThe name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setSslCertificates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource to set an\nSslCertificates 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": "projects/{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\nserver-side support for SSL features. This affects connections between\nclients and the HTTPS proxy load balancer. They do not affect the\nconnection between the load balancer and the backends.",
"flatPath": "projects/{project}/global/targetHttpsProxies/{targetHttpsProxy}/setSslPolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource whose SSL policy is\nto be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/targetHttpsProxies/{targetHttpsProxy}/setUrlMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetHttpsProxy": {
"description": "Name of the TargetHttpsProxy resource whose URL map is\nto 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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetInstances",
"httpMethod": "GET",
"id": "compute.targetInstances.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/zones/{zone}/targetInstances",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nproject and zone.",
"flatPath": "projects/{project}/zones/{zone}/targetInstances",
"httpMethod": "GET",
"id": "compute.targetInstances.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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"
]
},
"setSecurityPolicy": {
"description": "Sets the Google Cloud Armor security policy for the specified target\ninstance. For more information, seeGoogle\nCloud Armor Overview",
"flatPath": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy",
"httpMethod": "POST",
"id": "compute.targetInstances.setSecurityPolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetInstance": {
"description": "Name of the TargetInstance resource to which the security policy should be\nset. The name should conform to RFC1035.",
"location": "path",
"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": "projects/{project}/zones/{zone}/targetInstances/{targetInstance}/setSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"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.",
"flatPath": "projects/{project}/zones/{zone}/targetInstances/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.targetInstances.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": "projects/{project}/zones/{zone}/targetInstances/{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"
]
}
}
},
"targetPools": {
"methods": {
"addHealthCheck": {
"description": "Adds health check URLs to a target pool.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addHealthCheck",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/addInstance",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetPools",
"httpMethod": "GET",
"id": "compute.targetPools.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}",
"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": "projects/{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\ninstance that is referenced by the given target pool.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/getHealth",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/targetPools",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/targetPools",
"httpMethod": "GET",
"id": "compute.targetPools.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeHealthCheck",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/removeInstance",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setBackup",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"setSecurityPolicy": {
"description": "Sets the Google Cloud Armor security policy for the specified target pool.\nFor more information, seeGoogle\nCloud Armor Overview",
"flatPath": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy",
"httpMethod": "POST",
"id": "compute.targetPools.setSecurityPolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetPool": {
"description": "Name of the TargetPool resource to which the security policy should be\nset. The name should conform to RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/regions/{region}/targetPools/{targetPool}/setSecurityPolicy",
"request": {
"$ref": "SecurityPolicyReference"
},
"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.",
"flatPath": "projects/{project}/regions/{region}/targetPools/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.targetPools.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": "projects/{project}/regions/{region}/targetPools/{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"
]
}
}
},
"targetSslProxies": {
"methods": {
"delete": {
"description": "Deletes the specified TargetSslProxy resource.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/global/targetSslProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\navailable to the specified project.",
"flatPath": "projects/{project}/global/targetSslProxies",
"httpMethod": "GET",
"id": "compute.targetSslProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setBackendService",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose BackendService resource\nis 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": "projects/{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"
]
},
"setCertificateMap": {
"description": "Changes the Certificate Map for TargetSslProxy.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
"httpMethod": "POST",
"id": "compute.targetSslProxies.setCertificateMap",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose CertificateMap is\nto be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setCertificateMap",
"request": {
"$ref": "TargetSslProxiesSetCertificateMapRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"setProxyHeader": {
"description": "Changes the ProxyHeaderType for TargetSslProxy.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setProxyHeader",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslCertificates",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose SslCertificate resource\nis 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": "projects/{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\nserver-side support for SSL features. This affects connections between\nclients and the load balancer. They do not affect the\nconnection between the load balancer and the backends.",
"flatPath": "projects/{project}/global/targetSslProxies/{targetSslProxy}/setSslPolicy",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetSslProxy": {
"description": "Name of the TargetSslProxy resource whose SSL policy is\nto be set. The name must be 1-63 characters long, and comply with RFC1035.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/global/targetSslProxies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.targetSslProxies.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": "projects/{project}/global/targetSslProxies/{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"
]
}
}
},
"targetTcpProxies": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all TargetTcpProxy resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetTcpProxies",
"httpMethod": "GET",
"id": "compute.targetTcpProxies.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{project}/aggregated/targetTcpProxies",
"response": {
"$ref": "TargetTcpProxyAggregatedList"
},
"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 TargetTcpProxy resource.",
"flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/global/targetTcpProxies",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\navailable to the specified project.",
"flatPath": "projects/{project}/global/targetTcpProxies",
"httpMethod": "GET",
"id": "compute.targetTcpProxies.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setBackendService",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"targetTcpProxy": {
"description": "Name of the TargetTcpProxy resource whose BackendService resource\nis 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": "projects/{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.",
"flatPath": "projects/{project}/global/targetTcpProxies/{targetTcpProxy}/setProxyHeader",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource.",
"flatPath": "projects/{project}/global/targetTcpProxies/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.targetTcpProxies.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": "projects/{project}/global/targetTcpProxies/{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"
]
}
}
},
"targetVpnGateways": {
"methods": {
"aggregatedList": {
"description": "Retrieves an aggregated list of target VPN gateways.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/targetVpnGateways",
"httpMethod": "GET",
"id": "compute.targetVpnGateways.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{targetVpnGateway}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/targetVpnGateways",
"httpMethod": "GET",
"id": "compute.targetVpnGateways.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"setLabels": {
"description": "Sets the labels on a TargetVpnGateway. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.targetVpnGateways.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/targetVpnGateways/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"urlMaps": {
"methods": {
"aggregatedList": {
"description": "Retrieves the list of all UrlMap resources, regional and global,\navailable to the specified project.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/urlMaps",
"httpMethod": "GET",
"id": "compute.urlMaps.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/global/urlMaps",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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,\nscoped to the specified UrlMap.\n\nFor more information, see [Invalidating cached\ncontent](/cdn/docs/invalidating-cached-content).",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}/invalidateCache",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nproject.",
"flatPath": "projects/{project}/global/urlMaps",
"httpMethod": "GET",
"id": "compute.urlMaps.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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\nrequest. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/global/urlMaps/{urlMap}",
"request": {
"$ref": "UrlMap"
},
"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.",
"flatPath": "projects/{project}/global/urlMaps/{resource}/testIamPermissions",
"httpMethod": "POST",
"id": "compute.urlMaps.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": "projects/{project}/global/urlMaps/{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 the specified UrlMap resource with the data included in the\nrequest.",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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\nprovided UrlMap will be run. Calling this method does NOT create the\nUrlMap.",
"flatPath": "projects/{project}/global/urlMaps/{urlMap}/validate",
"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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/vpnGateways",
"httpMethod": "GET",
"id": "compute.vpnGateways.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}",
"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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways/{vpnGateway}/getStatus",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways",
"httpMethod": "GET",
"id": "compute.vpnGateways.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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 theLabeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/setLabels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnGateways/{resource}/testIamPermissions",
"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": "projects/{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.\n\nTo prevent failure, Google recommends that you set the\n`returnPartialSuccess` parameter to `true`.",
"flatPath": "projects/{project}/aggregated/vpnTunnels",
"httpMethod": "GET",
"id": "compute.vpnTunnels.aggregatedList",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"includeAllScopes": {
"description": "Indicates whether every visible scope for each scope type (zone, region,\nglobal) should be included in the response. For new resource types added\nafter this field, the flag has no effect as new resource types will always\ninclude every visible scope for each scope type in response. For resource\ntypes which predate this field, if this flag is omitted or false, only\nscopes of the scope types where the resource type is expected to be found\nwill be included.",
"location": "query",
"type": "boolean"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"serviceProjectNumber": {
"description": "The Shared VPC service project id or service project number for which\naggregated list request is invoked for subnetworks list-usable api.",
"format": "int64",
"location": "query",
"type": "string"
}
},
"path": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{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.",
"flatPath": "projects/{project}/regions/{region}/vpnTunnels/{vpnTunnel}",
"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": "projects/{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\nthe data included in the request.",
"flatPath": "projects/{project}/regions/{region}/vpnTunnels",
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
}
},
"path": "projects/{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\nproject and region.",
"flatPath": "projects/{project}/regions/{region}/vpnTunnels",
"httpMethod": "GET",
"id": "compute.vpnTunnels.list",
"parameterOrder": [
"project",
"region"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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"
]
},
"setLabels": {
"description": "Sets the labels on a VpnTunnel. To learn more about labels, read theLabeling\nResources documentation.",
"flatPath": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels",
"httpMethod": "POST",
"id": "compute.vpnTunnels.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/regions/{region}/vpnTunnels/{resource}/setLabels",
"request": {
"$ref": "RegionSetLabelsRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"wireGroups": {
"methods": {
"delete": {
"description": "Deletes the specified wire group in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"httpMethod": "DELETE",
"id": "compute.wireGroups.delete",
"parameterOrder": [
"project",
"crossSiteNetwork",
"wireGroup"
],
"parameters": {
"crossSiteNetwork": {
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"wireGroup": {
"description": "Name of the wire group resource to delete.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Gets the specified wire group resource in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"httpMethod": "GET",
"id": "compute.wireGroups.get",
"parameterOrder": [
"project",
"crossSiteNetwork",
"wireGroup"
],
"parameters": {
"crossSiteNetwork": {
"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"
},
"wireGroup": {
"description": "Name of the wire group resource to return.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"response": {
"$ref": "WireGroup"
},
"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 wire group in the specified project in the given scope\nusing the parameters that are included in the request.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups",
"httpMethod": "POST",
"id": "compute.wireGroups.insert",
"parameterOrder": [
"project",
"crossSiteNetwork"
],
"parameters": {
"crossSiteNetwork": {
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "[Input Only] Validate the new configuration, but don't create it.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups",
"request": {
"$ref": "WireGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists the wire groups for a project in the given scope.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups",
"httpMethod": "GET",
"id": "compute.wireGroups.list",
"parameterOrder": [
"project",
"crossSiteNetwork"
],
"parameters": {
"crossSiteNetwork": {
"location": "path",
"required": true,
"type": "string"
},
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups",
"response": {
"$ref": "WireGroupList"
},
"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 wire group resource with the data included in the\nrequest. This method supportsPATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
"flatPath": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"httpMethod": "PATCH",
"id": "compute.wireGroups.patch",
"parameterOrder": [
"project",
"crossSiteNetwork",
"wireGroup"
],
"parameters": {
"crossSiteNetwork": {
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "update_mask indicates fields to be updated as part of this request.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
},
"validateOnly": {
"description": "[Input Only] Validate the new configuration, but don't update it.",
"location": "query",
"type": "boolean"
},
"wireGroup": {
"description": "Name of the WireGroups resource to patch.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/global/crossSiteNetworks/{crossSiteNetwork}/wireGroups/{wireGroup}",
"request": {
"$ref": "WireGroup"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"zoneOperations": {
"methods": {
"delete": {
"description": "Deletes the specified zone-specific Operations resource.",
"flatPath": "projects/{project}/zones/{zone}/operations/{operation}",
"httpMethod": "DELETE",
"id": "compute.zoneOperations.delete",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to delete, or its unique numeric\nidentifier.",
"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": "projects/{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.",
"flatPath": "projects/{project}/zones/{zone}/operations/{operation}",
"httpMethod": "GET",
"id": "compute.zoneOperations.get",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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\nthe specified zone.",
"flatPath": "projects/{project}/zones/{zone}/operations",
"httpMethod": "GET",
"id": "compute.zoneOperations.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{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`\nor for the request to approach the 2 minute deadline, and retrieves the\nspecified Operation resource. This method waits for no more than the\n2 minutes and then returns the current state of the\noperation, which might be `DONE` or still in progress.\n\nThis method is called on a best-effort basis. Specifically:\n   \n   \n    - In uncommon cases, when the server is overloaded, the request might\n    return before the default deadline is reached, or might return after zero\n    seconds.\n   - If the default deadline is reached, there is no guarantee that the\n    operation is actually done when the method returns. Be prepared to retry\n    if the operation is not `DONE`.",
"flatPath": "projects/{project}/zones/{zone}/operations/{operation}/wait",
"httpMethod": "POST",
"id": "compute.zoneOperations.wait",
"parameterOrder": [
"project",
"zone",
"operation"
],
"parameters": {
"operation": {
"description": "Name of the Operations resource to return, or its unique numeric\nidentifier.",
"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": "projects/{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"
]
}
}
},
"zoneVmExtensionPolicies": {
"methods": {
"delete": {
"description": "Deletes a specified zone VM extension policy within a project.",
"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"httpMethod": "DELETE",
"id": "compute.zoneVmExtensionPolicies.delete",
"parameterOrder": [
"project",
"zone",
"vmExtensionPolicy"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"vmExtensionPolicy": {
"description": "Name of the zone VM extension policy to delete.",
"location": "path",
"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": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"get": {
"description": "Retrieves details of a specific zone VM extension policy within a project.",
"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"httpMethod": "GET",
"id": "compute.zoneVmExtensionPolicies.get",
"parameterOrder": [
"project",
"zone",
"vmExtensionPolicy"
],
"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"
},
"vmExtensionPolicy": {
"description": "Name of the VM extension policy 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 for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
"path": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"response": {
"$ref": "VmExtensionPolicy"
},
"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 zone-level VM extension policy within a project.",
"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies",
"httpMethod": "POST",
"id": "compute.zoneVmExtensionPolicies.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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(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": "projects/{project}/zones/{zone}/vmExtensionPolicies",
"request": {
"$ref": "VmExtensionPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
"list": {
"description": "Lists all VM extension policies within a specific zone for a project.",
"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies",
"httpMethod": "GET",
"id": "compute.zoneVmExtensionPolicies.list",
"parameterOrder": [
"project",
"zone"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
},
"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": "projects/{project}/zones/{zone}/vmExtensionPolicies",
"response": {
"$ref": "VmExtensionPolicyList"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute",
"https://www.googleapis.com/auth/compute.readonly"
]
},
"update": {
"description": "Modifies an existing zone VM extension policy within a project.",
"flatPath": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"httpMethod": "PATCH",
"id": "compute.zoneVmExtensionPolicies.update",
"parameterOrder": [
"project",
"zone",
"vmExtensionPolicy"
],
"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\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
"location": "query",
"type": "string"
},
"vmExtensionPolicy": {
"description": "Name of the zone VM extension policy to update.",
"location": "path",
"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": "projects/{project}/zones/{zone}/vmExtensionPolicies/{vmExtensionPolicy}",
"request": {
"$ref": "VmExtensionPolicy"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
}
}
},
"zones": {
"methods": {
"get": {
"description": "Returns the specified Zone resource.",
"flatPath": "projects/{project}/zones/{zone}",
"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": "projects/{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.",
"flatPath": "projects/{project}/zones",
"httpMethod": "GET",
"id": "compute.zones.list",
"parameterOrder": [
"project"
],
"parameters": {
"filter": {
"description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
"maxResults": {
"default": "500",
"description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`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\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
"pageToken": {
"description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe 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"
},
"returnPartialSuccess": {
"description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
"type": "boolean"
}
},
"path": "projects/{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": "20260422",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
"description": "Contains the configurations necessary to generate a signature for access to\nprivate storage buckets that support Signature Version 4 for authentication.\nThe service name for generating the authentication header will always default\nto 's3'.",
"id": "AWSV4Signature",
"properties": {
"accessKey": {
"description": "The access key used for s3 bucket authentication. Required for updating or\ncreating a backend that uses AWS v4 signature authentication, but will not\nbe returned as part of the configuration when queried with a REST API GET\nrequest.\n\n@InputOnly",
"type": "string"
},
"accessKeyId": {
"description": "The identifier of an access key used for s3 bucket authentication.",
"type": "string"
},
"accessKeyVersion": {
"description": "The optional version identifier for the access key. You can use this to\nkeep track of different iterations of your access key.",
"type": "string"
},
"originRegion": {
"description": "The name of the cloud region of your origin. This is a free-form field with\nthe name of the region your cloud uses to host your origin.  For example,\n\"us-east-1\" for AWS or \"us-ashburn-1\" for OCI.",
"type": "string"
}
},
"type": "object"
},
"AcceleratorConfig": {
"description": "A specification of the type and number of accelerator cards attached to the\ninstance.",
"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\ninstance. For example:projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100\nIf you are creating an instance template, specify only the\naccelerator name.\nSee GPUs on Compute Engine\nfor a full list of accelerator types.",
"type": "string"
}
},
"type": "object"
},
"AcceleratorTopologiesInfo": {
"description": "Info for accelerator topologies within a densely packed reservation.",
"id": "AcceleratorTopologiesInfo",
"properties": {
"acceleratorTopologyInfos": {
"description": "Info for each accelerator topology.",
"items": {
"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfo"
},
"type": "array"
}
},
"type": "object"
},
"AcceleratorTopologiesInfoAcceleratorTopologyInfo": {
"description": "Info for a slice of a given topology.",
"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfo",
"properties": {
"acceleratorTopology": {
"description": "The accelerator topology.",
"type": "string"
},
"infoPerTopologyStates": {
"description": "Info for each topology state.",
"items": {
"$ref": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState"
},
"type": "array"
}
},
"type": "object"
},
"AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState": {
"description": "Info for each topology state.",
"id": "AcceleratorTopologiesInfoAcceleratorTopologyInfoInfoPerTopologyState",
"properties": {
"count": {
"description": "The number of accelerator topologies in this state.",
"format": "int32",
"type": "integer"
},
"state": {
"description": "The state of the accelerator topology.",
"enum": [
"AVAILABLE",
"DEGRADED",
"RUNNING",
"TOPOLOGY_STATE_UNSPECIFIED",
"UNHEALTHY"
],
"enumDeprecated": [
false,
false,
false,
false,
true
],
"enumDescriptions": [
"The accelerator topology is available.",
"The accelerator topology is degraded. The underlying capacity is not in a\nhealthy state and is not available.",
"The accelerator topology is running. If there are both running and\ndegraded hosts within a topology, DEGRADED state will be returned.",
"The state of the topology is unspecified.",
"This value has been deprecated and is no longer used."
],
"type": "string"
}
},
"type": "object"
},
"AcceleratorType": {
"description": "Represents an Accelerator Type resource.\n\nGoogle Cloud Platform provides graphics processing units (accelerators) that\nyou can add to VM instances to improve or accelerate performance when working\nwith intensive workloads. For more information, readGPUs on Compute Engine.",
"id": "AcceleratorType",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#acceleratorType",
"description": "Output only. [Output Only] The type of the resource. Alwayscompute#acceleratorType for accelerator types.",
"readOnly": true,
"type": "string"
},
"maximumCardsPerInstance": {
"description": "[Output Only] Maximum number of 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. [Output Only] Server-defined, fully qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"zone": {
"description": "[Output Only] The name of the zone where the accelerator type resides,\nsuch as us-central1-a.\nYou must specify this field as part of the HTTP request URL. It is\nnot 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. [Output Only] Type of resource. Alwayscompute#acceleratorTypeAggregatedList for aggregated lists of\naccelerator types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Alwayscompute#acceleratorTypeList for lists of accelerator types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\ntypes list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nOnly one access config per instance is supported.",
"id": "AccessConfig",
"properties": {
"externalIpv6": {
"description": "Applies to ipv6AccessConfigs only.\nThe first IPv6 address of the external IPv6 range associated\nwith this instance, prefix length is stored inexternalIpv6PrefixLength in ipv6AccessConfig. To\nuse a static external IP address, it must be unused and in the same region\nas the instance's zone. If not specified, Google Cloud will automatically\nassign an external IPv6 address from the instance's subnetwork.",
"type": "string"
},
"externalIpv6PrefixLength": {
"description": "Applies to ipv6AccessConfigs only. The prefix length of the\nexternal IPv6 range.",
"format": "int32",
"type": "integer"
},
"kind": {
"default": "compute#accessConfig",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#accessConfig for access configs.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of this access configuration. In accessConfigs\n(IPv4), the default and recommended name is External NAT, but\nyou can use any arbitrary string, such as My external IP orNetwork Access. In ipv6AccessConfigs, the\nrecommend name is External IPv6.",
"type": "string"
},
"natIP": {
"description": "Applies to accessConfigs (IPv4) only. Anexternal IP\naddress associated with this instance. Specify an unused static\nexternal IP address available to the project or leave this field undefined\nto use an IP from a shared ephemeral IP address pool. If you specify a\nstatic external IP address, it must live in the same region as the zone of\nthe instance.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring this access\nconfiguration and can only take the following values: PREMIUM,STANDARD.\n\nIf an AccessConfig is specified without a valid external IP address, an\nephemeral IP will be created with this networkTier.\n\nIf an AccessConfig with a valid external IP address is specified, it must\nmatch that of the networkTier associated with the Address resource owning\nthat IP.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"type": "string"
},
"publicPtrDomainName": {
"description": "The DNS domain name for the public PTR record.\n\nYou can set this field only if the `setPublicPtr` field is enabled inaccessConfig. If this field is unspecified inipv6AccessConfig, a default PTR record will be created for\nfirst IP in associated external IPv6 range.",
"type": "string"
},
"securityPolicy": {
"description": "The resource URL for the security policy associated with this access\nconfig.",
"type": "string"
},
"setPublicPtr": {
"description": "Specifies whether a public DNS 'PTR' record should be created to map the\nexternal IP address of the instance to a DNS domain name.\n\nThis field is not used in ipv6AccessConfig. A default PTR\nrecord will be created if the VM has external IPv6 range associated.",
"type": "boolean"
},
"type": {
"description": "The type of configuration. In accessConfigs (IPv4), the\ndefault and only option is ONE_TO_ONE_NAT. Inipv6AccessConfigs, the default and only option isDIRECT_IPV6.",
"enum": [
"DIRECT_IPV6",
"ONE_TO_ONE_NAT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Address": {
"description": "Represents an IP Address resource.\n\nGoogle Compute Engine has two IP Address resources:\n\n* [Global (external and\ninternal)](https://cloud.google.com/compute/docs/reference/rest/v1/globalAddresses)\n* [Regional (external and\ninternal)](https://cloud.google.com/compute/docs/reference/rest/v1/addresses)\n\nFor more information, see\nReserving a static external IP address.",
"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 orEXTERNAL. If unspecified, defaults to EXTERNAL.",
"enum": [
"EXTERNAL",
"INTERNAL",
"UNSPECIFIED_TYPE"
],
"enumDescriptions": [
"A publicly visible external IP address.",
"A private network IP address, for use with an Instance or Internal Load\nBalancer forwarding rule.",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"ipCollection": {
"description": "Reference to the source of external IPv4 addresses,\nlike a PublicDelegatedPrefix (PDP) for BYOIP.\nThe PDP must support enhanced IPv4 allocations.\n\nUse one of the following formats to specify a PDP when reserving an\nexternal IPv4 address using BYOIP.\n   \n   - \n   Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n   - \n   Partial URL, as in\n     \n      \n          - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name\n          - regions/region/publicDelegatedPrefixes/pdp-name",
"type": "string"
},
"ipVersion": {
"description": "The IP version that will be used by this address. Valid options areIPV4 or IPV6.",
"enum": [
"IPV4",
"IPV6",
"UNSPECIFIED_VERSION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"ipv6EndpointType": {
"description": "The endpoint type of this address, which should be VM\nor NETLB. This is used for deciding which type of endpoint\nthis address can be used after the external IPv6 address reservation.",
"enum": [
"NETLB",
"VM"
],
"enumDescriptions": [
"Reserved IPv6 address can be used on network load balancer.",
"Reserved IPv6 address can be used on VM."
],
"type": "string"
},
"kind": {
"default": "compute#address",
"description": "Output only. [Output Only] Type of the resource. Always compute#address for\naddresses.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this Address, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an Address.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.addresses.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character\nmust be a lowercase letter, and all following characters (except for the\nlast character) must be a dash, lowercase letter, or digit. The last\ncharacter 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\nonly be used with INTERNAL type with theVPC_PEERING purpose.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring this address and\ncan only take the following values: PREMIUM orSTANDARD. Internal IP addresses are always Premium Tier;\nglobal external IP addresses are always Premium Tier; regional external IP\naddresses can be either Standard or Premium Tier.\n\nIf this field is not specified, it is assumed to be PREMIUM.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"type": "string"
},
"prefixLength": {
"description": "The prefix length if the resource represents an IP range.",
"format": "int32",
"type": "integer"
},
"purpose": {
"description": "The purpose of this resource, which can be one of the following values:\n   \n   \n     - GCE_ENDPOINT for addresses that are used by VM\n     instances, alias IP ranges, load balancers, and similar resources.\n     - DNS_RESOLVER for a DNS resolver address in a subnetwork\n       for a Cloud DNS  inbound\n       forwarder IP addresses (regional internal IP address in a subnet of\n       a VPC network)\n     - VPC_PEERING for global internal IP addresses used for\n      \n          private services access allocated ranges.\n     - NAT_AUTO for the regional external IP addresses used by\n          Cloud NAT when allocating addresses using\n          \n          automatic NAT IP address allocation.\n     - IPSEC_INTERCONNECT for addresses created from a private\n     IP range that are reserved for a VLAN attachment in an\n     *HA VPN over Cloud Interconnect* configuration. These addresses\n     are regional resources.\n     - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned\n     to multiple internal forwarding rules.\n     - `PRIVATE_SERVICE_CONNECT` for a private network address that is\n     used to configure Private Service Connect. Only global internal addresses\n     can use this purpose.",
"enum": [
"DNS_RESOLVER",
"GCE_ENDPOINT",
"IPSEC_INTERCONNECT",
"NAT_AUTO",
"PRIVATE_SERVICE_CONNECT",
"SERVERLESS",
"SHARED_LOADBALANCER_VIP",
"VPC_PEERING"
],
"enumDescriptions": [
"DNS resolver address in the subnetwork.",
"VM internal/alias IP, Internal LB service IP, etc.",
"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.",
"External IP automatically reserved for Cloud NAT.",
"A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL",
"A regional internal IP address range reserved for Serverless.",
"A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.",
"IP range for peer networks."
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] The URL of the region where a regional address resides.\nFor regional addresses, you must specify the region as a path parameter in\nthe HTTP request URL. *This field is not applicable to global\naddresses.*",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of the address, which can be one ofRESERVING, RESERVED, or IN_USE.\nAn address that is RESERVING is currently in the process of\nbeing reserved. A RESERVED address is currently reserved and\navailable to use. An IN_USE address is currently being used\nby another resource and is not available.",
"enum": [
"IN_USE",
"RESERVED",
"RESERVING"
],
"enumDescriptions": [
"Address is being used by another resource and is not available.",
"Address is reserved and available to use.",
"Address is being reserved."
],
"readOnly": true,
"type": "string"
},
"subnetwork": {
"description": "The URL of the subnetwork in which to reserve the address. If an IP address\nis specified, it must be within the subnetwork's IP range. This field can\nonly be used with INTERNAL type with aGCE_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. [Output Only] Type of resource. Alwayscompute#addressAggregatedList for aggregated lists of\naddresses.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#addressList for\nlists of addresses.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"AdvancedMachineFeatures": {
"description": "Specifies options for controlling advanced machine features.\nOptions that would traditionally be configured in a BIOS belong\nhere. Features that require operating system support may have\ncorresponding entries in the GuestOsFeatures of anImage (e.g., whether or not the OS in theImage supports nested virtualization being enabled or\ndisabled).",
"id": "AdvancedMachineFeatures",
"properties": {
"enableNestedVirtualization": {
"description": "Whether to enable nested virtualization or not (default is false).",
"type": "boolean"
},
"enableUefiNetworking": {
"description": "Whether to enable UEFI networking for instance creation.",
"type": "boolean"
},
"performanceMonitoringUnit": {
"description": "Type of Performance Monitoring Unit requested on instance.",
"enum": [
"ARCHITECTURAL",
"ENHANCED",
"PERFORMANCE_MONITORING_UNIT_UNSPECIFIED",
"STANDARD"
],
"enumDescriptions": [
"Architecturally defined non-LLC events.",
"Most documented core/L2 and LLC events.",
"",
"Most documented core/L2 events."
],
"type": "string"
},
"threadsPerCore": {
"description": "The number of threads per physical core. To disable simultaneous\nmultithreading (SMT) set this to 1. If unset, the maximum number\nof threads supported per core by the underlying processor is\nassumed.",
"format": "int32",
"type": "integer"
},
"turboMode": {
"description": "Turbo frequency mode to use for the instance.\nSupported modes include:\n* ALL_CORE_MAX\n\nUsing empty string or not setting this field will use the platform-specific\ndefault turbo mode.",
"type": "string"
},
"visibleCoreCount": {
"description": "The number of physical cores to expose to an instance. Multiply by\nthe number of threads per core to compute the total number of virtual\nCPUs to expose to the instance. If unset, the number of cores is\ninferred from the instance's nominal CPU count and the underlying\nplatform's SMT width.",
"format": "int32",
"type": "integer"
}
},
"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\nmust belong to the specified subnetwork and cannot contain IP addresses\nreserved by system or used by other network interfaces. This range may be\na single IP address (such as 10.2.3.4), a netmask (such as/24) or a CIDR-formatted string (such as10.1.2.0/24).",
"type": "string"
},
"subnetworkRangeName": {
"description": "The name of a subnetwork secondary IP range from which to allocate an IP\nalias range. If not specified, the primary range of the subnetwork is used.",
"type": "string"
}
},
"type": "object"
},
"AllocationAggregateReservation": {
"description": "This reservation type is specified by total resource amounts (e.g. total\ncount of CPUs) and can account for multiple instance SKUs. In other words,\none can create instances of varying shapes against this reservation.",
"id": "AllocationAggregateReservation",
"properties": {
"inUseResources": {
"description": "Output only. [Output only] List of resources currently in use.",
"items": {
"$ref": "AllocationAggregateReservationReservedResourceInfo"
},
"readOnly": true,
"type": "array"
},
"reservedResources": {
"description": "List of reserved resources (CPUs, memory, accelerators).",
"items": {
"$ref": "AllocationAggregateReservationReservedResourceInfo"
},
"type": "array"
},
"vmFamily": {
"description": "The VM family that all instances scheduled against this reservation must\nbelong to.",
"enum": [
"VM_FAMILY_CLOUD_TPU_DEVICE_CT3",
"VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L",
"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP",
"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"workloadType": {
"description": "The workload type of the instances that will target this reservation.",
"enum": [
"BATCH",
"SERVING",
"UNSPECIFIED"
],
"enumDescriptions": [
"Reserved resources will be optimized for BATCH workloads, such as ML\ntraining.",
"Reserved resources will be optimized for SERVING workloads, such as ML\ninference.",
""
],
"type": "string"
}
},
"type": "object"
},
"AllocationAggregateReservationReservedResourceInfo": {
"id": "AllocationAggregateReservationReservedResourceInfo",
"properties": {
"accelerator": {
"$ref": "AllocationAggregateReservationReservedResourceInfoAccelerator",
"description": "Properties of accelerator resources in this reservation."
}
},
"type": "object"
},
"AllocationAggregateReservationReservedResourceInfoAccelerator": {
"id": "AllocationAggregateReservationReservedResourceInfoAccelerator",
"properties": {
"acceleratorCount": {
"description": "Number of accelerators of specified type.",
"format": "int32",
"type": "integer"
},
"acceleratorType": {
"description": "Full or partial URL to accelerator type. e.g.\n\"projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l\"",
"type": "string"
}
},
"type": "object"
},
"AllocationReservationSharingPolicy": {
"id": "AllocationReservationSharingPolicy",
"properties": {
"serviceShareType": {
"description": "Sharing config for all Google Cloud services.",
"enum": [
"ALLOW_ALL",
"DISALLOW_ALL",
"SERVICE_SHARE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Allow all Google Cloud managed services to share reservations.",
"[Default] Disallow sharing with all Google Cloud services.",
""
],
"type": "string"
}
},
"type": "object"
},
"AllocationResourceStatus": {
"description": "[Output Only] Contains output only fields.",
"id": "AllocationResourceStatus",
"properties": {
"healthInfo": {
"$ref": "AllocationResourceStatusHealthInfo",
"description": "[Output only] Health information for the reservation."
},
"reservationBlockCount": {
"description": "The number of reservation blocks associated with this reservation.",
"format": "int32",
"type": "integer"
},
"reservationMaintenance": {
"$ref": "GroupMaintenanceInfo",
"description": "Maintenance information for this reservation"
},
"specificSkuAllocation": {
"$ref": "AllocationResourceStatusSpecificSKUAllocation",
"description": "Allocation Properties of this reservation."
}
},
"type": "object"
},
"AllocationResourceStatusHealthInfo": {
"description": "Health information for the reservation.",
"id": "AllocationResourceStatusHealthInfo",
"properties": {
"degradedBlockCount": {
"description": "The number of reservation blocks that are degraded.",
"format": "int32",
"type": "integer"
},
"healthStatus": {
"description": "The health status of the reservation.",
"enum": [
"DEGRADED",
"HEALTHY",
"HEALTH_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The reservation is degraded.",
"The reservation is healthy.",
"The health status of the reservation is unspecified."
],
"type": "string"
},
"healthyBlockCount": {
"description": "The number of reservation blocks that are healthy.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"AllocationResourceStatusSpecificSKUAllocation": {
"description": "Contains Properties set for the reservation.",
"id": "AllocationResourceStatusSpecificSKUAllocation",
"properties": {
"sourceInstanceTemplateId": {
"description": "ID of the instance template used to populate reservation properties.",
"type": "string"
},
"utilizations": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
"description": "Per service utilization breakdown. The Key is the Google Cloud managed\nservice name.",
"type": "object"
}
},
"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\neither SCSI or NVME. The default isSCSI.\nFor performance characteristics of SCSI over NVMe, seeLocal SSD performance.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AllocationSpecificSKUAllocationReservedInstanceProperties": {
"description": "Properties of the SKU instances being reserved.\nNext ID: 10",
"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\nof disk is local-ssd.",
"items": {
"$ref": "AllocationSpecificSKUAllocationAllocatedInstancePropertiesReservedDisk"
},
"type": "array"
},
"locationHint": {
"description": "An opaque location hint used to place the allocation close to other\nresources.\nThis field is for use by internal tools that use the public API.",
"type": "string"
},
"machineType": {
"description": "Specifies type of machine (name only) which has fixed number of vCPUs\nand fixed amount of memory. This also includes specifying custom\nmachine 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\n configuration.",
"id": "AllocationSpecificSKUReservation",
"properties": {
"assuredCount": {
"description": "Output only. [Output Only] Indicates how many instances are actually usable currently.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"count": {
"description": "Specifies the number of resources that are allocated.",
"format": "int64",
"type": "string"
},
"inUseCount": {
"description": "Output only. [Output Only] Indicates how many instances are in use.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"instanceProperties": {
"$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"description": "The instance properties for the reservation."
},
"sourceInstanceTemplate": {
"description": "Specifies the instance template to create the reservation. If you use\nthis field, you must exclude the instanceProperties field.\n\nThis field is optional, and it can be a full or partial URL. For example,\nthe following are all valid URLs to an instance template: \n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate\n      - projects/project/global/instanceTemplates/instanceTemplate\n      - global/instanceTemplates/instanceTemplate",
"type": "string"
}
},
"type": "object"
},
"AttachedDisk": {
"description": "An instance-attached disk resource.",
"id": "AttachedDisk",
"properties": {
"architecture": {
"description": "Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64\nor X86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"readOnly": true,
"type": "string"
},
"autoDelete": {
"description": "Specifies whether the disk will be auto-deleted when the instance is\ndeleted (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\npartition 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\nrunning within the instance. This name can be used to reference the device\nfor mounting, resizing, and so on, from within the instance.\n\nIf not specified, the server chooses a default device name to apply to this\ndisk, in the form persistent-disk-x, where x is a number\nassigned by Google Compute Engine. This field is only applicable for\npersistent disks.",
"type": "string"
},
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts or decrypts a disk using acustomer-supplied\nencryption key.\n\nIf you are creating a new disk, this field encrypts the new disk using\nan encryption key that you provide. If you are attaching an existing\ndisk that is already encrypted, this field decrypts the disk using\nthe customer-supplied encryption key.\n\nIf you encrypt a disk using a customer-supplied key, you must provide the\nsame key again when you attempt to use this resource at a later time. For\nexample, you must provide the key when you create a snapshot or an image\nfrom 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\nusing an automatically generated key and you do not need to provide a key\nto use the disk later.\n\nNote:\n\nInstance templates do not storecustomer-supplied\nencryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.\n\nYou cannot create VMs that have disks with customer-supplied keys using\nthe bulk\ninsert method."
},
"diskSizeGb": {
"description": "The size of the disk in GB.",
"format": "int64",
"type": "string"
},
"forceAttach": {
"description": "[Input Only] Whether to force attach the regional disk even if it's\ncurrently attached to another instance. If you try to force attach a zonal\ndisk to an instance, you will receive an error.",
"type": "boolean"
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable\nonly for bootable images. Read\nEnabling guest operating system features to see a list of available\noptions.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"index": {
"description": "Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the\nboot disk. If you have many disks attached to an instance, each\ndisk would have a unique index number.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"initializeParams": {
"$ref": "AttachedDiskInitializeParams",
"description": "[Input Only] Specifies the parameters for a new disk that will be created\nalongside the new instance. Use initialization parameters to create boot\ndisks or local SSDs attached to the new instance.\n\nThis property is mutually exclusive with the source property;\nyou can only define one or the other, but not both."
},
"interface": {
"description": "Specifies the disk interface to use for attaching this disk, which is\neither SCSI or NVME. For most machine types, the\ndefault is SCSI. Local SSDs can use either NVME or SCSI.\nIn certain configurations, persistent disks can use NVMe. For more\ninformation, seeAbout\npersistent disks.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#attachedDisk",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.",
"readOnly": true,
"type": "string"
},
"licenses": {
"description": "Output only. [Output Only] Any valid publicly visible licenses.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"mode": {
"description": "The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk\nin READ_WRITE mode.",
"enum": [
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"Attaches this disk in read-only mode. Multiple virtual machines can use\na disk in read-only mode at a time.",
"*[Default]* Attaches this disk in read-write mode. Only one\nvirtual machine at a time can be attached to a disk in read-write mode."
],
"type": "string"
},
"savedState": {
"description": "Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this\nfield is set to PRESERVED if the LocalSSD data has been saved\nto a persistent location by customer request.  (see the\ndiscard_local_ssd option on Stop/Suspend).\nRead-only in the api.",
"enum": [
"DISK_SAVED_STATE_UNSPECIFIED",
"PRESERVED"
],
"enumDescriptions": [
"*[Default]* Disk state has not been preserved.",
"Disk state has been preserved."
],
"readOnly": true,
"type": "string"
},
"shieldedInstanceInitialState": {
"$ref": "InitialStateConfig",
"description": "Output only. [Output Only] shielded vm initial state stored on disk",
"readOnly": true
},
"source": {
"description": "Specifies a valid partial or full URL to an existing Persistent Disk\nresource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source\nis required.\n\nIf desired, you can also attach existing non-root persistent disks using\nthis property. This field is only applicable for persistent disks.\n\nNote that for InstanceTemplate, specify the disk name for zonal disk,\nand the URL for regional disk.",
"type": "string"
},
"type": {
"description": "Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.",
"enum": [
"PERSISTENT",
"SCRATCH"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"AttachedDiskInitializeParams": {
"description": "[Input Only] Specifies the parameters for a new disk that will be created\nalongside the new instance. Use initialization parameters to create boot\ndisks or local SSDs attached to the new instance.\n\nThis field is persisted and returned for instanceTemplate and not returned\nin the context of instance.\n\nThis property is mutually exclusive with the source property;\nyou can only define one or the other, but not both.",
"id": "AttachedDiskInitializeParams",
"properties": {
"architecture": {
"description": "The architecture of the attached disk. Valid values are\narm64 or x86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"type": "string"
},
"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\nof the instance. If a disk with the same name already exists in the given\nregion, the existing disk is attached to the new instance and the\nnew disk is not created.",
"type": "string"
},
"diskSizeGb": {
"description": "Specifies the size of the disk in base-2 GB. The size must be at least\n10 GB. If you specify a sourceImage, which is required for\nboot disks, the default size is the size of the sourceImage.\nIf you do not specify a sourceImage, the default disk size\nis 500 GB.",
"format": "int64",
"type": "string"
},
"diskType": {
"description": "Specifies the disk type to use to create the instance. If not specified,\nthe default is pd-standard, specified using the full URL.\nFor example:\n\nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard\n\n\nFor a full list of acceptable values, seePersistent disk\ntypes. If you specify this field when creating a VM, you can provide\neither the full or partial URL. For example, the following values are\nvalid:\n   \n   \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\n\n\nIf you specify this field when creating or updating an instance template\nor all-instances configuration, specify the type of the disk, not the\nURL. For example: pd-standard.",
"type": "string"
},
"enableConfidentialCompute": {
"description": "Whether this disk is using confidential compute mode.",
"type": "boolean"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this disk. These can be later modified by thedisks.setLabels method. This field is only applicable for\npersistent disks.",
"type": "object"
},
"licenses": {
"description": "A list of publicly visible licenses. Reserved for Google's use.",
"items": {
"type": "string"
},
"type": "array"
},
"onUpdateAction": {
"description": "Specifies which action to take on instance update with this disk. Default\nis to use the existing disk.",
"enum": [
"RECREATE_DISK",
"RECREATE_DISK_IF_SOURCE_CHANGED",
"USE_EXISTING_DISK"
],
"enumDescriptions": [
"Always recreate the disk.",
"Recreate the disk if source (image, snapshot) of this disk is different\nfrom source of existing disk.",
"Use the existing disk, this is the default behaviour."
],
"type": "string"
},
"provisionedIops": {
"description": "Indicates how many IOPS to provision for the disk. This sets the number\nof I/O operations per second that the disk can handle. Values must be\nbetween 10,000 and 120,000. For more details, see theExtreme persistent\ndisk documentation.",
"format": "int64",
"type": "string"
},
"provisionedThroughput": {
"description": "Indicates how much throughput to provision for the disk. This sets the\nnumber of throughput mb per second that the disk can handle. Values must\ngreater than or equal to 1.",
"format": "int64",
"type": "string"
},
"replicaZones": {
"description": "Required for each regional disk associated with the instance. Specify\nthe URLs of the zones where the disk should be replicated to.\nYou must provide exactly two replica zones, and one zone must be the same\nas the instance zone.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT & PATCH) when\nempty.",
"type": "object"
},
"resourcePolicies": {
"description": "Resource policies applied to this disk for automatic snapshot creations.\nSpecified using the full or partial URL. For instance template, specify\nonly the resource policy name.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceImage": {
"description": "The source image to create this disk. When creating a new instance boot\ndisk, one of initializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source\nis required.\n\nTo create a disk with one of the public operating system\nimages, specify the image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:\n\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the\nimage name in the following format:\n\nglobal/images/my-custom-image\n\n\nYou can also specify a custom image by its image family, which returns\nthe latest version of the image in that family. Replace the image name\nwith family/family-name:\n\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": "Thecustomer-supplied\nencryption key of the source image. Required if the source image is\nprotected by a customer-supplied encryption key.\n\nInstanceTemplate and InstancePropertiesPatch do not storecustomer-supplied\nencryption keys, so you cannot create disks for instances in a managed instance group if the\nsource images are encrypted with your own keys."
},
"sourceSnapshot": {
"description": "The source snapshot to create this disk. When creating a new instance\nboot disk, one of initializeParams.sourceSnapshot orinitializeParams.sourceImage or disks.source\nis required.\n\nTo create a disk with a snapshot that you created, specify the\nsnapshot name in the following format:\n\nglobal/snapshots/my-backup\n\n\nIf the source snapshot is deleted later, this field will not be set.\n\nNote: You cannot create VMs in bulk using a snapshot as the source. Use\nan image instead when you create VMs using\nthe bulk\ninsert method.",
"type": "string"
},
"sourceSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Thecustomer-supplied\nencryption key of the source snapshot."
},
"storagePool": {
"description": "The storage pool in which the new disk is created. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool\n     - projects/project/zones/zone/storagePools/storagePool \n   - zones/zone/storagePools/storagePool",
"type": "string"
}
},
"type": "object"
},
"AuditConfig": {
"description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditLogConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n    {\n      \"audit_configs\": [\n        {\n          \"service\": \"allServices\",\n          \"audit_log_configs\": [\n            {\n              \"log_type\": \"DATA_READ\",\n              \"exempted_members\": [\n                \"user:jose@example.com\"\n              ]\n            },\n            {\n              \"log_type\": \"DATA_WRITE\"\n            },\n            {\n              \"log_type\": \"ADMIN_READ\"\n            }\n          ]\n        },\n        {\n          \"service\": \"sampleservice.googleapis.com\",\n          \"audit_log_configs\": [\n            {\n              \"log_type\": \"DATA_READ\"\n            },\n            {\n              \"log_type\": \"DATA_WRITE\",\n              \"exempted_members\": [\n                \"user:aliya@example.com\"\n              ]\n            }\n          ]\n        }\n      ]\n    }\n\nFor sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts `jose@example.com` from DATA_READ logging, and\n`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"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "Provides the configuration for logging a type of permissions.\nExample:\n\n    {\n      \"audit_log_configs\": [\n        {\n          \"log_type\": \"DATA_READ\",\n          \"exempted_members\": [\n            \"user:jose@example.com\"\n          ]\n        },\n        {\n          \"log_type\": \"DATA_WRITE\"\n        }\n      ]\n    }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\njose@example.com from DATA_READ logging.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"ADMIN_READ",
"DATA_READ",
"DATA_WRITE",
"LOG_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Admin reads. Example: CloudIAM getIamPolicy",
"Data reads. Example: CloudSQL Users list",
"Data writes. Example: CloudSQL Users create",
"Default case. Should never be this."
],
"type": "string"
}
},
"type": "object"
},
"Autoscaler": {
"description": "Represents an Autoscaler resource.\n\nGoogle Compute Engine has two Autoscaler resources:\n\n* [Zonal](/compute/docs/reference/rest/v1/autoscalers)\n* [Regional](/compute/docs/reference/rest/v1/regionAutoscalers)\n\nUse autoscalers to automatically add or delete instances from a\nmanaged instance group according to your defined autoscaling policy.\nFor more information, read Autoscaling Groups of Instances.\n\nFor zonal managed instance groups resource, use the autoscaler\nresource.\n\nFor regional managed instance groups, use theregionAutoscalers resource.",
"id": "Autoscaler",
"properties": {
"autoscalingPolicy": {
"$ref": "AutoscalingPolicy",
"description": "The configuration parameters for the autoscaling algorithm. You can define\none or more signals for an autoscaler: cpuUtilization,customMetricUtilizations, andloadBalancingUtilization.\n\nIf none of these are specified, the default will be to autoscale based oncpuUtilization to 0.6 or 60%."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#autoscaler",
"description": "Output only. [Output Only] Type of the resource. Always compute#autoscaler\nfor autoscalers.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.autoscalers.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"recommendedSize": {
"description": "Output only. [Output Only] Target recommended MIG size (number of instances) computed by\nautoscaler. Autoscaler calculates the recommended MIG size even when the\nautoscaling policy mode is different from ON. This field is empty when\nautoscaler is not connected to an existing managed instance group or\nautoscaler did not generate its prediction.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"region": {
"description": "Output only. [Output Only] URL of theregion\nwhere the instance group resides (for autoscalers living in regional\nscope).",
"readOnly": true,
"type": "string"
},
"scalingScheduleStatus": {
"additionalProperties": {
"$ref": "ScalingScheduleStatus"
},
"description": "Output only. [Output Only] Status information of existing scaling schedules.",
"readOnly": true,
"type": "object"
},
"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\npossible values:\n   \n   - PENDING:\n     Autoscaler backend hasn't read new/updated configuration.\n   - DELETING:\n     Configuration is being deleted.\n   - ACTIVE:\n     Configuration is acknowledged to be effective. Some warnings might\n     be present in the statusDetails field.\n   - ERROR:\n     Configuration has errors. Actionable for users. Details are present in\n     the statusDetails field.\n\n\nNew values might be added in the future.",
"enum": [
"ACTIVE",
"DELETING",
"ERROR",
"PENDING"
],
"enumDescriptions": [
"Configuration is acknowledged to be effective",
"Configuration is being deleted",
"Configuration has errors. Actionable for users.",
"Autoscaler backend hasn't read new/updated configuration"
],
"type": "string"
},
"statusDetails": {
"description": "[Output Only] Human-readable details about the current state of the\nautoscaler. Read the documentation forCommonly\nreturned status messages for examples of status messages you might\nencounter.",
"items": {
"$ref": "AutoscalerStatusDetails"
},
"type": "array"
},
"target": {
"description": "URL of the managed instance group that this autoscaler will scale. This\nfield is required when creating an autoscaler.",
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] URL of thezone\nwhere the instance group resides (for autoscalers living in zonal scope).",
"readOnly": true,
"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. [Output Only] Type of resource. Alwayscompute#autoscalerAggregatedList for aggregated lists of\nautoscalers.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#autoscalerList\nfor lists of autoscalers.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nvalues:\n   \n   - ALL_INSTANCES_UNHEALTHY (WARNING):\n     All instances in the instance group are unhealthy (not in RUNNING\n     state).\n   - BACKEND_SERVICE_DOES_NOT_EXIST (ERROR):\n     There is no backend service attached to the instance group.\n   - CAPPED_AT_MAX_NUM_REPLICAS (WARNING):\n     Autoscaler recommends a size greater than maxNumReplicas.\n   - CUSTOM_METRIC_DATA_POINTS_TOO_SPARSE (WARNING):\n     The custom metric samples are not exported often enough to be\n     a credible base for autoscaling.\n   - CUSTOM_METRIC_INVALID (ERROR):\n     The custom metric that was specified does not exist or does not have\n     the necessary labels.\n   - MIN_EQUALS_MAX (WARNING):\n     The minNumReplicas is equal to maxNumReplicas. This means the\n     autoscaler cannot add or remove instances from the instance group.\n   - MISSING_CUSTOM_METRIC_DATA_POINTS (WARNING):\n     The autoscaler did not receive any data from the custom metric\n     configured for autoscaling.\n   - MISSING_LOAD_BALANCING_DATA_POINTS (WARNING):\n     The autoscaler is configured to scale based on a load balancing signal\n     but the instance group has not received any requests from the load\n     balancer.\n   - MODE_OFF (WARNING):\n     Autoscaling is turned off. The number of instances in the group won't\n     change automatically. The autoscaling configuration is preserved.\n   - MODE_ONLY_UP (WARNING):\n     Autoscaling is in the \"Autoscale only out\" mode. The autoscaler can add\n     instances but not remove any.\n   - MORE_THAN_ONE_BACKEND_SERVICE (ERROR):\n     The instance group cannot be autoscaled because it has more than one\n     backend service attached to it.\n   - NOT_ENOUGH_QUOTA_AVAILABLE (ERROR):\n     There is insufficient quota for the necessary resources, such as CPU or\n     number of instances.\n   - REGION_RESOURCE_STOCKOUT (ERROR):\n     Shown only for regional autoscalers: there is a resource stockout in\n     the chosen region.\n   - SCALING_TARGET_DOES_NOT_EXIST (ERROR):\n     The target to be scaled does not exist.\n   - UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION\n     (ERROR): Autoscaling does not work with an HTTP/S load balancer that\n     has been configured for maxRate.\n   - ZONE_RESOURCE_STOCKOUT (ERROR):\n     For zonal autoscalers: there is a resource stockout in the chosen zone.\n     For regional autoscalers: in at least one of the zones you're using\n     there is a resource stockout.\n\n\nNew values might be added in the future. Some of the values might not be\navailable 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_SCALE_OUT",
"MODE_ONLY_UP",
"MORE_THAN_ONE_BACKEND_SERVICE",
"NOT_ENOUGH_QUOTA_AVAILABLE",
"REGION_RESOURCE_STOCKOUT",
"SCALING_TARGET_DOES_NOT_EXIST",
"SCHEDULED_INSTANCES_GREATER_THAN_AUTOSCALER_MAX",
"SCHEDULED_INSTANCES_LESS_THAN_AUTOSCALER_MIN",
"UNKNOWN",
"UNSUPPORTED_MAX_RATE_LOAD_BALANCING_CONFIGURATION",
"ZONE_RESOURCE_STOCKOUT"
],
"enumDescriptions": [
"All instances in the instance group are unhealthy (not in RUNNING state).",
"There is no backend service attached to the instance group.",
"Autoscaler recommends a size greater than maxNumReplicas.",
"The custom metric samples are not exported often enough to be a credible\nbase for autoscaling.",
"The custom metric that was specified does not exist or does not have the\nnecessary labels.",
"The minNumReplicas is equal to maxNumReplicas. This means the autoscaler\ncannot add or remove instances from the instance group.",
"The autoscaler did not receive any data from the custom metric configured\nfor autoscaling.",
"The autoscaler is configured to scale based on a load balancing signal\nbut the instance group has not received any requests from the load\nbalancer.",
"Autoscaling is turned off. The number of instances in the group won't\nchange automatically. The autoscaling configuration is preserved.",
"Autoscaling is in the \"Autoscale only scale out\" mode.\nInstances in the group will be only added.",
"Autoscaling is in the \"Autoscale only out\" mode. Instances in the group\nwill be only added.",
"The instance group cannot be autoscaled because it has more than one\nbackend service attached to it.",
"There is insufficient quota for the necessary resources, such as CPU or\nnumber of instances.",
"Showed only for regional autoscalers: there is a resource stockout in\nthe chosen region.",
"The target to be scaled does not exist.",
"For some scaling schedules minRequiredReplicas is greater than\nmaxNumReplicas. Autoscaler always recommends at most maxNumReplicas\ninstances.",
"For some scaling schedules minRequiredReplicas is less than\nminNumReplicas. Autoscaler always recommends at least minNumReplicas\ninstances.",
"",
"Autoscaling does not work with an HTTP/S load balancer that has been\nconfigured for maxRate.",
"For zonal autoscalers: there is a resource stockout in the chosen zone.\nFor regional autoscalers: in at least one of the zones you're using there\nis a resource stockout."
],
"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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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 your application takes to initialize on a VM\ninstance. This is referred to as the\n[initialization period](/compute/docs/autoscaler#cool_down_period).\nSpecifying an accurate initialization period improves\nautoscaler decisions. For example, when scaling out, the autoscaler ignores\ndata from VMs that are still initializing because those VMs might not yet\nrepresent normal usage of your application. The default initialization\nperiod is 60 seconds.\n\nInitialization periods might vary because of numerous\nfactors. We recommend that you test how long your application takes to\ninitialize. To do this, create a VM and time your application's startup\nprocess.",
"format": "int32",
"type": "integer"
},
"cpuUtilization": {
"$ref": "AutoscalingPolicyCpuUtilization",
"description": "Defines the CPU utilization policy that allows the autoscaler to scale\nbased 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 out to. This\nis required when creating or updating an autoscaler. The maximum number\nof replicas must not be lower than minimal number of replicas.",
"format": "int32",
"type": "integer"
},
"minNumReplicas": {
"description": "The minimum number of replicas that the autoscaler can scale in to.\nThis cannot be less than 0. If not provided, autoscaler chooses a\ndefault value depending on maximum number of instances allowed.",
"format": "int32",
"type": "integer"
},
"mode": {
"description": "Defines the operating mode for this policy.\nThe following modes are available:\n   \n   - OFF: Disables the autoscaler but maintains its\n   configuration.\n   - ONLY_SCALE_OUT: Restricts the autoscaler to add\n   VM instances only.\n   - ON: Enables all autoscaler activities according to its\n   policy.\n\n\nFor more information, see \n\"Turning off or restricting an autoscaler\"",
"enum": [
"OFF",
"ON",
"ONLY_SCALE_OUT",
"ONLY_UP"
],
"enumDescriptions": [
"Do not automatically scale the MIG in or out.\nThe recommended_size field contains the size of MIG that would be set if\nthe actuation mode was enabled.",
"Automatically scale the MIG in and out according to the policy.",
"Automatically create VMs according to the policy, but do not scale\nthe MIG in.",
"Automatically create VMs according to the policy, but do not scale\nthe MIG in."
],
"type": "string"
},
"scaleInControl": {
"$ref": "AutoscalingPolicyScaleInControl"
},
"scalingSchedules": {
"additionalProperties": {
"$ref": "AutoscalingPolicyScalingSchedule"
},
"description": "Scaling schedules defined for an autoscaler. Multiple schedules\ncan be set on an autoscaler, and they can overlap. During overlapping\nperiods the greatest min_required_replicas of all scaling schedules is\napplied. Up to 128 scaling schedules are allowed.",
"type": "object"
},
"stabilizationPeriodSec": {
"description": "The number of seconds that autoscaler waits for load stabilization before\nmaking scale-in decisions. This is referred to as the\n[stabilization period](/compute/docs/autoscaler#stabilization_period).\nThis might appear as a delay in scaling in but it is an important mechanism\nfor your application to not have fluctuating size due to short term load\nfluctuations.\n\nThe default stabilization period is 600 seconds.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"AutoscalingPolicyCpuUtilization": {
"description": "CPU utilization policy.",
"id": "AutoscalingPolicyCpuUtilization",
"properties": {
"predictiveMethod": {
"description": "Indicates whether predictive autoscaling based on CPU metric is enabled.\nValid values are:\n\n* NONE (default). No predictive method is used. The autoscaler scales the\ngroup to meet current demand based on real-time metrics.\n* OPTIMIZE_AVAILABILITY. Predictive autoscaling improves availability by\nmonitoring daily and weekly load patterns and scaling out ahead of\nanticipated demand.",
"enum": [
"NONE",
"OPTIMIZE_AVAILABILITY"
],
"enumDescriptions": [
"No predictive method is used. The autoscaler scales the group to meet\ncurrent demand based on real-time metrics",
"Predictive autoscaling improves availability by monitoring daily and\nweekly load patterns and scaling out ahead of anticipated demand."
],
"type": "string"
},
"utilizationTarget": {
"description": "The target CPU utilization that the autoscaler maintains. Must be\na float value in the range (0, 1]. If not specified, the default is0.6.\n\nIf the CPU level is below the target utilization, the autoscaler scales\nin the number of instances until it reaches the minimum number of\ninstances you specified or until the average CPU of your instances\nreaches the target utilization.\n\nIf the average CPU is above the target utilization, the autoscaler\nscales out until it reaches the maximum number of instances you\nspecified or until the average utilization reaches the target\nutilization.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"AutoscalingPolicyCustomMetricUtilization": {
"description": "Custom utilization metric policy.",
"id": "AutoscalingPolicyCustomMetricUtilization",
"properties": {
"filter": {
"description": "A filter string, compatible with a Stackdriver Monitoringfilter string forTimeSeries.list API call. This filter is\nused to select a specific TimeSeries for the purpose of autoscaling and\nto determine whether the metric is exporting per-instance or\nper-group data.\n\nFor the filter to be valid for autoscaling purposes, the following rules\napply:\n   \n   \n    - You can only use the AND operator for joining\n       selectors.\n    - You can only use direct equality comparison operator\n       (=) without any functions for each selector.\n    - You can specify the metric in both the filter string and in the\n       metric field. However, if specified in both places, the metric must\n       be identical.\n    - The monitored resource type\n       determines what kind of values are expected for the metric. If it is\n       a gce_instance, the autoscaler expects the metric to\n       include a separate TimeSeries for each instance in a group. In such a\n       case, you cannot filter on resource labels.\n       \n   \n   If the resource type is any other value, the autoscaler expects\n       this metric to contain values that apply to the entire autoscaled\n       instance group and resource label filtering can be performed to\n       point autoscaler at the correct TimeSeries to scale upon. This is\n       called a *per-group metric* for the purpose of autoscaling.\n   \n       If not specified, the type defaults to\n       gce_instance.\n\n\n\nTry to provide a filter that is selective enough to pick just one\nTimeSeries for the autoscaled group or for each of the instances (if you\nare using gce_instance resource type). If multiple\nTimeSeries are returned upon the query execution, the autoscaler will sum\ntheir respective values to obtain its scaling value.",
"type": "string"
},
"metric": {
"description": "The identifier (type) of the Stackdriver Monitoring metric. The metric\ncannot have negative values.\n\nThe metric must have a value type of INT64 orDOUBLE.",
"type": "string"
},
"singleInstanceAssignment": {
"description": "If scaling is based on a per-group metric value that represents the\ntotal amount of work to be done or resource usage, set this value to an\namount assigned for a single instance of the scaled group. Autoscaler\nkeeps the number of instances proportional to the value of this\nmetric. The metric itself does not change value due to group\nresizing.\n\nA good metric to use with the target is for examplepubsub.googleapis.com/subscription/num_undelivered_messages\nor a custom metric exporting the total number of requests coming to\nyour instances.\n\nA bad example would be a metric exporting an average or median latency,\nsince this value can't include a chunk assignable to a single instance,\nit could be better used with utilization_target instead.",
"format": "double",
"type": "number"
},
"utilizationTarget": {
"description": "The target value of the metric that autoscaler maintains. This\nmust be a positive value. A utilization metric scales number of\nvirtual machines handling requests to increase or decrease\nproportionally to the metric.\n\nFor example, a good metric to use as a utilization_target ishttps://www.googleapis.com/compute/v1/instance/network/received_bytes_count.\nThe autoscaler works to keep this value constant for each of the\ninstances.",
"format": "double",
"type": "number"
},
"utilizationTargetType": {
"description": "Defines how target utilization value is expressed for a Stackdriver\nMonitoring metric. Either GAUGE,DELTA_PER_SECOND, or DELTA_PER_MINUTE.",
"enum": [
"DELTA_PER_MINUTE",
"DELTA_PER_SECOND",
"GAUGE"
],
"enumDescriptions": [
"Sets the utilization target value for a cumulative or delta metric,\nexpressed as the rate of growth per minute.",
"Sets the utilization target value for a cumulative or delta metric,\nexpressed as the rate of growth per second.",
"Sets the utilization target value for a gauge metric. The autoscaler\nwill collect the average utilization of the virtual machines from the\nlast couple of minutes, and compare the value to the utilization\ntarget value to perform autoscaling."
],
"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\nconfiguration) that the autoscaler maintains. Must be a positive float\nvalue. If not defined, the default is 0.8.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"AutoscalingPolicyScaleInControl": {
"description": "Configuration that allows for slower scale in so that even if Autoscaler\nrecommends an abrupt scale in of a MIG, it will be throttled as specified\nby the parameters below.",
"id": "AutoscalingPolicyScaleInControl",
"properties": {
"maxScaledInReplicas": {
"$ref": "FixedOrPercent",
"description": "Maximum allowed number (or %) of VMs that can be deducted from the peak\nrecommendation during the window autoscaler looks at when computing\nrecommendations. Possibly all these VMs can be deleted at once so user\nservice needs to be prepared to lose that many VMs in one step."
},
"timeWindowSec": {
"description": "How far back autoscaling looks when computing recommendations to\ninclude directives regarding slower scale in, as described above.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"AutoscalingPolicyScalingSchedule": {
"description": "Scaling based on user-defined schedule. The message describes a single\nscaling schedule. A scaling schedule changes the minimum number of VM\ninstances an autoscaler can recommend, which can trigger scaling out.",
"id": "AutoscalingPolicyScalingSchedule",
"properties": {
"description": {
"description": "A description of a scaling schedule.",
"type": "string"
},
"disabled": {
"description": "A boolean value that specifies whether a scaling schedule can influence\nautoscaler recommendations. If set to true, then a scaling schedule has\nno effect. This field is optional, and its value is false by default.",
"type": "boolean"
},
"durationSec": {
"description": "The duration of time intervals, in seconds, for which this\nscaling schedule is to run. The minimum allowed value is 300.\nThis field is required.",
"format": "int32",
"type": "integer"
},
"minRequiredReplicas": {
"description": "The minimum number of VM instances that the autoscaler will\nrecommend in time intervals starting according to schedule. This field is\nrequired.",
"format": "int32",
"type": "integer"
},
"schedule": {
"description": "The start timestamps of time intervals when this scaling\nschedule is to provide a scaling signal. This field uses the extended\ncron format (with an optional year field). The expression can describe a\nsingle timestamp if the optional year is set, in which case the scaling\nschedule runs once. The schedule is interpreted with respect to\ntime_zone. This field is required. Note: These timestamps only describe\nwhen autoscaler starts providing the scaling signal. The VMs\nneed additional time to become serving.",
"type": "string"
},
"timeZone": {
"description": "The time zone to use when interpreting the schedule.\nThe value of this field must be a time zone name from the tz database:\nhttps://en.wikipedia.org/wiki/Tz_database. This field is assigned a\ndefault value of \"UTC\" if left empty.",
"type": "string"
}
},
"type": "object"
},
"Backend": {
"description": "Message containing information of one individual backend.",
"id": "Backend",
"properties": {
"balancingMode": {
"description": "Specifies how to determine whether the backend of a load balancer can\nhandle additional traffic or is fully loaded. For usage guidelines, see\nConnection balancing mode.\n\nBackends must use compatible balancing modes. For more information, see\nSupported balancing modes and target capacity settings and\nRestrictions and guidance for instance groups.\n\nNote: Currently, if you use the API to configure incompatible balancing\nmodes, the configuration might be accepted even though it has no impact\nand is ignored. Specifically, Backend.maxUtilization is ignored when\nBackend.balancingMode is RATE. In the future, this incompatible combination\nwill be rejected.",
"enum": [
"CONNECTION",
"CUSTOM_METRICS",
"IN_FLIGHT",
"RATE",
"UTILIZATION"
],
"enumDescriptions": [
"Balance based on the number of simultaneous connections.",
"Based on custom defined and reported metrics.",
"Balance based on the number of in-flight requests.",
"Balance based on requests per second (RPS).",
"Balance based on the backend utilization."
],
"type": "string"
},
"capacityScaler": {
"description": "A multiplier applied to the backend's target capacity of its balancing\nmode.\nThe default value is 1, which means the group serves up to\n100% of its configured capacity (depending onbalancingMode). A setting of 0 means the group is\ncompletely drained, offering 0% of its available capacity. The valid ranges\nare 0.0 and [0.1,1.0].\nYou cannot configure a setting larger than 0 and smaller than0.1.\nYou cannot configure a setting of 0 when there is only one\nbackend attached to the backend service.\n\nNot available with backends that don't support using abalancingMode. This includes backends such as global\ninternet NEGs, regional serverless NEGs, and PSC NEGs.",
"format": "float",
"type": "number"
},
"customMetrics": {
"description": "List of custom metrics that are used for CUSTOM_METRICS\nBalancingMode.",
"items": {
"$ref": "BackendCustomMetric"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"failover": {
"description": "This field designates whether this is a failover backend. More than one\nfailover backend can be configured for a given BackendService.",
"type": "boolean"
},
"group": {
"description": "The fully-qualified URL of aninstance\ngroup or network endpoint\ngroup (NEG) resource. To determine what types of backends a load\nbalancer supports, see the [Backend services\noverview](https://cloud.google.com/load-balancing/docs/backend-service#backends).\n\nYou must use the *fully-qualified* URL (starting withhttps://www.googleapis.com/) to specify the instance group\nor NEG. Partial URLs are not supported.\n\nIf haPolicy is specified, backends must refer to NEG resources of type\nGCE_VM_IP.",
"type": "string"
},
"maxConnections": {
"description": "Defines a target maximum number of simultaneous connections. For usage\nguidelines, seeConnection\nbalancing mode and Utilization\nbalancing mode. Not available if the backend'sbalancingMode is RATE.",
"format": "int32",
"type": "integer"
},
"maxConnectionsPerEndpoint": {
"description": "Defines a target maximum number of simultaneous connections.  For usage\nguidelines, seeConnection\nbalancing mode and Utilization\nbalancing mode.\n\nNot available if the backend's balancingMode isRATE.",
"format": "int32",
"type": "integer"
},
"maxConnectionsPerInstance": {
"description": "Defines a target maximum number of simultaneous connections.\nFor usage guidelines, seeConnection\nbalancing mode and Utilization\nbalancing mode.\n\nNot available if the backend's balancingMode isRATE.",
"format": "int32",
"type": "integer"
},
"maxInFlightRequests": {
"description": "Defines a maximum number of in-flight requests for the whole NEG or\ninstance group. Not available if backend's balancingMode isRATE or CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxInFlightRequestsPerEndpoint": {
"description": "Defines a maximum number of in-flight requests for a single endpoint.\nNot available if backend's balancingMode is RATE\nor CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxInFlightRequestsPerInstance": {
"description": "Defines a maximum number of in-flight requests for a single VM.\nNot available if backend's balancingMode is RATE\nor CONNECTION.",
"format": "int32",
"type": "integer"
},
"maxRate": {
"description": "Defines a maximum number of HTTP requests per second (RPS). For\nusage guidelines, seeRate\nbalancing mode and Utilization\nbalancing mode.\n\nNot available if the backend's balancingMode isCONNECTION.",
"format": "int32",
"type": "integer"
},
"maxRatePerEndpoint": {
"description": "Defines a maximum target for requests per second (RPS). For usage\nguidelines, seeRate\nbalancing mode and Utilization\nbalancing mode.\n\nNot available if the backend's balancingMode isCONNECTION.",
"format": "float",
"type": "number"
},
"maxRatePerInstance": {
"description": "Defines a maximum target for requests per second (RPS). For usage\nguidelines, seeRate\nbalancing mode and Utilization\nbalancing mode.\n\nNot available if the backend's balancingMode isCONNECTION.",
"format": "float",
"type": "number"
},
"maxUtilization": {
"description": "Optional parameter to define a target capacity for theUTILIZATION balancing mode. The valid range is[0.0, 1.0].\n\nFor usage guidelines, seeUtilization\nbalancing mode.",
"format": "float",
"type": "number"
},
"orchestrationInfo": {
"$ref": "BackendBackendOrchestrationInfo",
"description": "Information about the resource or system that manages the backend."
},
"preference": {
"description": "This field indicates whether this backend should be fully utilized before\nsending traffic to backends with default preference. The possible values\nare:\n   \n   - PREFERRED: Backends with this preference level will be\n   filled up to their capacity limits first, based on RTT.\n   - DEFAULT:  If preferred backends don't have enough\n   capacity, backends in this layer would be used and traffic would be\n   assigned based on the load balancing algorithm you use. This is the\n   default",
"enum": [
"DEFAULT",
"PREFERENCE_UNSPECIFIED",
"PREFERRED"
],
"enumDescriptions": [
"No preference.",
"If preference is unspecified, we set it to the DEFAULT value",
"Traffic will be sent to this backend first."
],
"type": "string"
},
"trafficDuration": {
"enum": [
"LONG",
"SHORT",
"TRAFFIC_DURATION_UNSPECIFIED"
],
"enumDescriptions": [
"Most of the requests are expected to take more than multiple seconds to\nfinish.",
"Most requests are expected to finish with a sub-second latency.",
"Traffic duration is unspecified."
],
"type": "string"
}
},
"type": "object"
},
"BackendBackendOrchestrationInfo": {
"description": "A message containing information about the resource or system that manages\nthe backend.",
"id": "BackendBackendOrchestrationInfo",
"properties": {
"resourceUri": {
"description": "The URI of the resource or system that manages the backend.",
"type": "string"
}
},
"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\nbalancer. For more information, readBackend Buckets.",
"id": "BackendBucket",
"properties": {
"bucketName": {
"description": "Cloud Storage bucket name.",
"type": "string"
},
"cdnPolicy": {
"$ref": "BackendBucketCdnPolicy",
"description": "Cloud CDN configuration for this BackendBucket."
},
"compressionMode": {
"description": "Compress text responses using Brotli or gzip compression, based on\nthe client's Accept-Encoding header.",
"enum": [
"AUTOMATIC",
"DISABLED"
],
"enumDescriptions": [
"Automatically uses the best compression based on the Accept-Encoding\nheader sent by the client.",
"Disables compression. Existing compressed responses cached by\nCloud CDN will not be served to clients."
],
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"customResponseHeaders": {
"description": "Headers that the Application Load Balancer should add to proxied responses.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "An optional textual description of the resource; provided by the client\nwhen the resource is created.",
"type": "string"
},
"edgeSecurityPolicy": {
"description": "[Output Only] The resource URL for the edge security policy associated with\nthis backend bucket.",
"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": "Output only. Type of the resource.",
"readOnly": true,
"type": "string"
},
"loadBalancingScheme": {
"description": "The value can only be INTERNAL_MANAGED for cross-region internal layer 7\nload balancer.\n\nIf loadBalancingScheme is not specified, the backend bucket can be used by\nclassic global external load balancers, or global application external load\nbalancers, or both.",
"enum": [
"EXTERNAL_MANAGED",
"INTERNAL_MANAGED"
],
"enumDescriptions": [
"Signifies that this will be used for regional external Application Load\nBalancers.",
"Signifies that this will be used for internal Application Load Balancers."
],
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "BackendBucketParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional backend bucket\nresides. This field is not applicable to global backend buckets.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"usedBy": {
"description": "Output only. [Output Only] List of resources referencing that backend bucket.",
"items": {
"$ref": "BackendBucketUsedBy"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"BackendBucketAggregatedList": {
"id": "BackendBucketAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "BackendBucketsScopedList",
"description": "Name of the scope containing this set of BackendBuckets."
},
"description": "A list of BackendBucketsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#backendBucketAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendBucketCdnPolicy": {
"description": "Message containing Cloud CDN configuration for a backend bucket.",
"id": "BackendBucketCdnPolicy",
"properties": {
"bypassCacheOnRequestHeaders": {
"description": "Bypass the cache when the specified request headers are matched - e.g.\nPragma or Authorization headers. Up to 5 headers can be specified.\nThe cache is bypassed for all cdnPolicy.cacheMode settings.",
"items": {
"$ref": "BackendBucketCdnPolicyBypassCacheOnRequestHeader"
},
"type": "array"
},
"cacheKeyPolicy": {
"$ref": "BackendBucketCdnPolicyCacheKeyPolicy",
"description": "The CacheKeyPolicy for this CdnPolicy."
},
"cacheMode": {
"description": "Specifies the cache setting for all responses from this backend.\nThe possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching\nheaders to cache content. Responses without these headers will not be\ncached at Google's edge, and will require a full trip to the origin on\nevery request, potentially impacting performance and increasing load on\nthe origin server.FORCE_CACHE_ALL Cache all content, ignoring any \"private\",\n\"no-store\" or \"no-cache\" directives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,\nincluding common image formats, media (video and audio), and web assets\n(JavaScript and CSS). Requests and responses that are marked as\nuncacheable, as well as dynamic content (including HTML), will not be\ncached.\n\nIf no value is provided for cdnPolicy.cacheMode, it defaults\nto CACHE_ALL_STATIC.",
"enum": [
"CACHE_ALL_STATIC",
"FORCE_CACHE_ALL",
"INVALID_CACHE_MODE",
"USE_ORIGIN_HEADERS"
],
"enumDescriptions": [
"Automatically cache static content, including common image formats,\nmedia (video and audio), and web assets (JavaScript and CSS).\nRequests and responses that are marked as uncacheable, as well as\ndynamic content (including HTML), will not be cached.",
"Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\"\ndirectives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.",
"",
"Requires the origin to set valid caching headers to cache content.\nResponses without these headers will not be cached at Google's edge,\nand will require a full trip to the origin on every request,\npotentially impacting performance and increasing load on the\norigin server."
],
"type": "string"
},
"clientTtl": {
"description": "Specifies a separate client (e.g. browser client) maximum TTL. This is\nused to clamp the max-age (or Expires) value sent to the client.  With\nFORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the\nresponse max-age directive, along with a \"public\" directive.  For\ncacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age\nfrom the origin (if specified), or else sets the response max-age\ndirective to the lesser of the client_ttl and default_ttl, and also\nensures a \"public\" cache-control directive is present.\nIf a client TTL is not specified, a default value (1 hour) will be used.\nThe maximum allowed value is 31,622,400s (1 year).",
"format": "int32",
"type": "integer"
},
"defaultTtl": {
"description": "Specifies the default TTL for cached content served by this origin for\nresponses that do not have an existing valid TTL (max-age or s-maxage).\nSetting a TTL of \"0\" means \"always revalidate\".\nThe value of defaultTTL cannot be set to a value greater than that of\nmaxTTL, but can be equal.\nWhen the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL\nwill overwrite the TTL set in all responses. The maximum allowed value is\n31,622,400s (1 year), noting that infrequently accessed objects may be\nevicted from the cache before the defined TTL.",
"format": "int32",
"type": "integer"
},
"maxTtl": {
"description": "Specifies the maximum allowed TTL for cached content served by this\norigin.\nCache directives that attempt to set a max-age or s-maxage higher than\nthis, or an Expires header more than maxTTL seconds in the future will\nbe capped at the value of maxTTL, as if it were the value of an\ns-maxage Cache-Control directive.\nHeaders sent to the client will not be modified.\nSetting a TTL of \"0\" means \"always revalidate\".\nThe maximum allowed value is 31,622,400s (1 year), noting that\ninfrequently accessed objects may be evicted from the cache before\nthe defined TTL.",
"format": "int32",
"type": "integer"
},
"negativeCaching": {
"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,\nnegative caching applies to responses with the specified response code\nthat lack any Cache-Control, Expires, or Pragma: no-cache directives.\nWhen the cache mode is set to FORCE_CACHE_ALL, negative caching applies\nto all responses with the specified response code, and override any\ncaching headers.\nBy default, Cloud CDN will apply the following default TTLs to these\nstatus codes:\nHTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\nHTTP 404 (Not Found), 410 (Gone),\n451 (Unavailable For Legal Reasons): 120s\nHTTP 405 (Method Not Found), 501 (Not Implemented): 60s.\nThese defaults can be overridden in negative_caching_policy.",
"type": "boolean"
},
"negativeCachingPolicy": {
"description": "Sets a cache TTL for the specified HTTP status code.\nnegative_caching must be enabled to configure negative_caching_policy.\nOmitting the policy and leaving negative_caching enabled will use\nCloud CDN's default cache TTLs.\nNote that when specifying an explicit negative_caching_policy, you\nshould take care to specify a cache TTL for all response codes\nthat you wish to cache. Cloud CDN will not apply any default\nnegative caching when a policy exists.",
"items": {
"$ref": "BackendBucketCdnPolicyNegativeCachingPolicy"
},
"type": "array"
},
"requestCoalescing": {
"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin.",
"type": "boolean"
},
"serveWhileStale": {
"description": "Serve existing content from the cache (if available) when revalidating\ncontent with the origin, or when an error is encountered when refreshing\nthe cache.\nThis setting defines the default \"max-stale\" duration for any cached\nresponses that do not specify a max-stale directive. Stale responses that\nexceed the TTL configured here will not be served. The default limit\n(max-stale) is 86400s (1 day), which will allow stale content to be\nserved up to this limit beyond the max-age (or s-maxage) of a cached\nresponse.\nThe maximum allowed value is 604800 (1 week).\nSet this to zero (0) to disable serve-while-stale.",
"format": "int32",
"type": "integer"
},
"signedUrlCacheMaxAgeSec": {
"description": "Maximum number of seconds the response to a signed URL request will be\nconsidered fresh. After this time period, the response will be\nrevalidated before being served. Defaults to 1hr (3600s).  When serving\nresponses to signed URL requests, Cloud CDN will internally behave as\nthough all responses from this backend had a \"Cache-Control:\npublic, max-age=[TTL]\" header, regardless of any existing\nCache-Control header. The actual headers served in responses will not be\naltered.",
"format": "int64",
"type": "string"
},
"signedUrlKeyNames": {
"description": "[Output Only] Names of the keys for signing request URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackendBucketCdnPolicyBypassCacheOnRequestHeader": {
"description": "Bypass the cache when the specified request headers are present,\ne.g. Pragma or Authorization headers. Values are case insensitive.\nThe presence of such a header overrides the cache_mode setting.",
"id": "BackendBucketCdnPolicyBypassCacheOnRequestHeader",
"properties": {
"headerName": {
"description": "The header field name to match on when bypassing cache.\nValues are case-insensitive.",
"type": "string"
}
},
"type": "object"
},
"BackendBucketCdnPolicyCacheKeyPolicy": {
"description": "Message containing what to include in the cache key for a request for\nCloud CDN.",
"id": "BackendBucketCdnPolicyCacheKeyPolicy",
"properties": {
"includeHttpHeaders": {
"description": "Allows HTTP request headers (by name) to be used in the cache key.",
"items": {
"type": "string"
},
"type": "array"
},
"queryStringWhitelist": {
"description": "Names of query string parameters to include in cache keys. Default\nparameters are always included. '&' and '=' will be percent encoded\nand not treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackendBucketCdnPolicyNegativeCachingPolicy": {
"description": "Specify CDN TTLs for response error codes.",
"id": "BackendBucketCdnPolicyNegativeCachingPolicy",
"properties": {
"code": {
"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
"format": "int32",
"type": "integer"
},
"ttl": {
"description": "The TTL (in seconds) for which to cache responses with the\ncorresponding status code.\nThe maximum allowed value is 1800s (30 minutes), noting that\ninfrequently accessed objects may be evicted from the cache before the\ndefined TTL.",
"format": "int32",
"type": "integer"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendBucketListUsable": {
"id": "BackendBucketListUsable",
"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#usableBackendBucketList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#usableBackendBucketList for lists of usable backend\nbuckets.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendBucketParams": {
"description": "Additional Backend Bucket parameters.",
"id": "BackendBucketParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"BackendBucketUsedBy": {
"id": "BackendBucketUsedBy",
"properties": {
"reference": {
"description": "Output only. [Output Only] Server-defined URL for UrlMaps referencing that\nBackendBucket.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackendBucketsScopedList": {
"id": "BackendBucketsScopedList",
"properties": {
"backendBuckets": {
"description": "A list of BackendBuckets contained in this scope.",
"items": {
"$ref": "BackendBucket"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendCustomMetric": {
"description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode.",
"id": "BackendCustomMetric",
"properties": {
"dryRun": {
"description": "If true, the metric data is collected and reported to Cloud\nMonitoring, but is not used for load balancing.",
"type": "boolean"
},
"maxUtilization": {
"description": "Optional parameter to define a target utilization for the Custom Metrics\nbalancing mode. The valid range is [0.0, 1.0].",
"format": "float",
"type": "number"
},
"name": {
"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"BackendService": {
"description": "Represents a Backend Service resource.\n\nA backend service defines how Google Cloud load balancers distribute traffic.\nThe backend service configuration contains a set of values, such as the\nprotocol used to connect to backends, various distribution and session\nsettings, health checks, and timeouts. These settings provide fine-grained\ncontrol over how your load balancer behaves. Most of the settings have\ndefault values that allow for easy configuration if you need to get started\nquickly.\n\nBackend services in Google Compute Engine can be either regionally or\nglobally scoped.\n\n* [Global](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)\n* [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/regionBackendServices)\n\nFor more information, seeBackend\nServices.",
"id": "BackendService",
"properties": {
"affinityCookieTtlSec": {
"description": "Lifetime of cookies in seconds. This setting is applicable to Application\nLoad Balancers and Traffic Director and requires\nGENERATED_COOKIE or HTTP_COOKIE session affinity.\n\nIf set to 0, the cookie is non-persistent and lasts only until\nthe end of the browser session (or equivalent). The maximum allowed value\nis two weeks (1,209,600).\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.",
"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. Only available for\nspecified load balancer types."
},
"circuitBreakers": {
"$ref": "CircuitBreakers"
},
"compressionMode": {
"description": "Compress text responses using Brotli or gzip compression, based on\nthe client's Accept-Encoding header.",
"enum": [
"AUTOMATIC",
"DISABLED"
],
"enumDescriptions": [
"Automatically uses the best compression based on the Accept-Encoding\nheader sent by the client.",
"Disables compression. Existing compressed responses cached by\nCloud CDN will not be served to clients."
],
"type": "string"
},
"connectionDraining": {
"$ref": "ConnectionDraining",
"description": "connectionDraining cannot be specified with haPolicy."
},
"connectionTrackingPolicy": {
"$ref": "BackendServiceConnectionTrackingPolicy",
"description": "Connection Tracking configuration for this BackendService. Connection\ntracking policy settings are only available for external passthrough\nNetwork Load Balancers and internal passthrough Network Load Balancers.\n\nconnectionTrackingPolicy cannot be specified with haPolicy."
},
"consistentHash": {
"$ref": "ConsistentHashLoadBalancerSettings",
"description": "Consistent Hash-based load balancing can be used to provide soft session\naffinity based on HTTP headers, cookies or other properties. This load\nbalancing policy is applicable only for HTTP connections. The affinity to a\nparticular destination host will be lost when one or more hosts are\nadded/removed from the destination service. This field specifies parameters\nthat control consistent hashing. This field is only applicable whenlocalityLbPolicy is set to MAGLEV orRING_HASH.\n\nThis field is applicable to either:\n   \n   - A regional backend service with the service protocol set to HTTP,\n   HTTPS, HTTP2 or H2C, and load_balancing_scheme set to\n   INTERNAL_MANAGED. \n   - A global backend service with the\n   load_balancing_scheme set to INTERNAL_SELF_MANAGED."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"customMetrics": {
"description": "List of custom metrics that are used for theWEIGHTED_ROUND_ROBIN locality_lb_policy.",
"items": {
"$ref": "BackendServiceCustomMetric"
},
"type": "array"
},
"customRequestHeaders": {
"description": "Headers that the load balancer adds to proxied requests. See [Creating\ncustom\nheaders](https://cloud.google.com/load-balancing/docs/custom-headers).",
"items": {
"type": "string"
},
"type": "array"
},
"customResponseHeaders": {
"description": "Headers that the load balancer adds to proxied responses. See [Creating\ncustom\nheaders](https://cloud.google.com/load-balancing/docs/custom-headers).",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"edgeSecurityPolicy": {
"description": "[Output Only] The resource URL for the edge security policy associated with\nthis backend service.",
"type": "string"
},
"enableCDN": {
"description": "If true, enables Cloud CDN for the backend service of a\nglobal external Application Load Balancer.",
"type": "boolean"
},
"externalManagedMigrationState": {
"description": "Specifies the canary migration state. Possible values are PREPARE,\nTEST_BY_PERCENTAGE, and TEST_ALL_TRAFFIC.\n\nTo begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be\nchanged to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before\nthe loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the\nTEST_BY_PERCENTAGE state can be used to migrate traffic by percentage using\nexternalManagedMigrationTestingPercentage.\n\nRolling back a migration requires the states to be set in reverse order. So\nchanging the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to\nbe set to TEST_ALL_TRAFFIC at the same time. Optionally, the\nTEST_BY_PERCENTAGE state can be used to migrate some traffic back to\nEXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.",
"enum": [
"PREPARE",
"TEST_ALL_TRAFFIC",
"TEST_BY_PERCENTAGE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"externalManagedMigrationTestingPercentage": {
"description": "Determines the fraction of requests that should be processed by the Global\nexternal Application Load Balancer.\n\nThe value of this field must be in the range [0, 100].\n\nSession affinity options will slightly affect this routing behavior, for\nmore details, see:Session\nAffinity.\n\nThis value can only be set if the loadBalancingScheme in the BackendService\nis set to EXTERNAL (when using the classic Application Load Balancer) and\nthe migration state is TEST_BY_PERCENTAGE.",
"format": "float",
"type": "number"
},
"failoverPolicy": {
"$ref": "BackendServiceFailoverPolicy",
"description": "Requires at least one backend instance group to be defined\nas a backup (failover) backend.\nFor load balancers that have configurable failover:\n[Internal passthrough Network Load\nBalancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)\nand [external passthrough Network Load\nBalancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).\n\nfailoverPolicy cannot be specified with haPolicy."
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a BackendService. An up-to-date fingerprint must be provided in\norder to update the BackendService, otherwise the request will\nfail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a BackendService.",
"format": "byte",
"type": "string"
},
"haPolicy": {
"$ref": "BackendServiceHAPolicy",
"description": "Configures self-managed High Availability (HA) for External and Internal\nProtocol Forwarding.\n\nThe backends of this regional backend service must only specify zonal\nnetwork endpoint groups (NEGs) of type GCE_VM_IP.\n\nWhen haPolicy is set for an Internal Passthrough Network Load Balancer, the\nregional backend service must set the network field. All zonal NEGs must\nbelong to the same network. However, individual NEGs can\nbelong to different subnetworks of that network.\n\nWhen haPolicy is specified, the set of attached network endpoints across\nall backends comprise an High Availability domain from which one endpoint\nis selected as the active endpoint (the leader) that receives all\ntraffic.\n\nhaPolicy can be added only at backend service creation time. Once set up,\nit cannot be deleted.\n\nNote that haPolicy is not for load balancing, and therefore cannot be\nspecified with sessionAffinity, connectionTrackingPolicy, and\nfailoverPolicy.\n\nhaPolicy requires customers to be responsible for tracking backend\nendpoint health and electing a leader among the healthy endpoints.\nTherefore, haPolicy cannot be specified with healthChecks.\n\nhaPolicy can only be specified for External Passthrough Network Load\nBalancers and Internal Passthrough Network Load Balancers."
},
"healthChecks": {
"description": "The list of URLs to the healthChecks, httpHealthChecks (legacy), or\nhttpsHealthChecks (legacy) resource for health checking this backend\nservice. Not all backend services support legacy health checks. See\nLoad balancer guide. Currently, at most one health check can be\nspecified for each backend service. Backend services with\ninstance group or zonal NEG backends must have a health check unless\nhaPolicy is specified. Backend services with internet or serverless NEG\nbackends must not have a health check.\n\nhealthChecks[] cannot be specified with haPolicy.",
"items": {
"type": "string"
},
"type": "array"
},
"iap": {
"$ref": "BackendServiceIAP",
"description": "The configurations for Identity-Aware Proxy on this resource.\nNot available for internal passthrough Network Load Balancers and external\npassthrough Network Load Balancers."
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"ipAddressSelectionPolicy": {
"description": "Specifies a preference for traffic sent from the proxy to the backend (or\nfrom the client to the backend for proxyless gRPC).\nThe possible values are:\n   \n   - IPV4_ONLY: Only send IPv4 traffic to the backends of the\n   backend service (Instance Group, Managed Instance Group, Network Endpoint\n   Group), regardless of traffic from the client to the proxy. Only IPv4\n   health checks are used to check the health of the backends. This is the\n   default setting.\n   - PREFER_IPV6: Prioritize the connection to the endpoint's\n   IPv6 address over its IPv4 address (provided there is a healthy IPv6\n   address).\n   - IPV6_ONLY: Only send IPv6 traffic to the backends of the\n   backend service (Instance Group, Managed Instance Group, Network Endpoint\n   Group), regardless of traffic from the client to the proxy. Only IPv6\n   health checks are used to check the health of the backends.\n\n\n\nThis field is applicable to either:\n   \n   -  Advanced global external Application Load Balancer (load balancing\n   scheme EXTERNAL_MANAGED), \n   -  Regional external Application Load\n   Balancer, \n   -  Internal proxy Network Load Balancer (load balancing\n   scheme INTERNAL_MANAGED), \n   -  Regional internal Application Load\n   Balancer (load balancing scheme INTERNAL_MANAGED), \n   -  Traffic\n   Director with Envoy proxies and proxyless gRPC (load balancing scheme\n   INTERNAL_SELF_MANAGED).",
"enum": [
"IPV4_ONLY",
"IPV6_ONLY",
"IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED",
"PREFER_IPV6"
],
"enumDescriptions": [
"Only send IPv4 traffic to the backends of the Backend Service\n(Instance Group, Managed Instance Group, Network Endpoint Group)\nregardless of traffic from the client to the proxy.\nOnly IPv4 health-checks are used to check the health of the backends.\nThis is the default setting.",
"Only send IPv6 traffic to the backends of the Backend Service\n(Instance Group, Managed Instance Group, Network Endpoint Group)\nregardless of traffic from the client to the proxy. Only IPv6\nhealth-checks are used to check the health of the backends.",
"Unspecified IP address selection policy.",
"Prioritize the connection to the endpoints IPv6 address\nover its IPv4 address (provided there is a healthy IPv6 address)."
],
"type": "string"
},
"kind": {
"default": "compute#backendService",
"description": "Output only. [Output Only] Type of resource. Always compute#backendService\nfor backend services.",
"readOnly": true,
"type": "string"
},
"loadBalancingScheme": {
"description": "Specifies the load balancer type. A backend service\ncreated for one type of load balancer cannot be used with another.\nFor more information, refer toChoosing\na load balancer.",
"enum": [
"EXTERNAL",
"EXTERNAL_MANAGED",
"INTERNAL",
"INTERNAL_MANAGED",
"INTERNAL_SELF_MANAGED",
"INVALID_LOAD_BALANCING_SCHEME"
],
"enumDescriptions": [
"Signifies that this will be used for classic Application Load Balancers,\nglobal external proxy Network Load Balancers,\nor external passthrough Network Load Balancers.",
"Signifies that this will be used for global external Application Load\nBalancers, regional external Application Load Balancers, or regional\nexternal proxy Network Load Balancers.",
"Signifies that this will be used for internal passthrough Network Load\nBalancers.",
"Signifies that this will be used for internal Application Load Balancers.",
"Signifies that this will be used by Traffic Director.",
""
],
"type": "string"
},
"localityLbPolicies": {
"description": "A list of locality load-balancing policies to be used in order of\npreference. When you use localityLbPolicies, you must set at least one\nvalue for either the localityLbPolicies[].policy or the\nlocalityLbPolicies[].customPolicy field. localityLbPolicies overrides any\nvalue set in the localityLbPolicy field.\n\nFor an example of how to use this field, seeDefine\na list of preferred policies.\n\nCaution: This field and its children are intended for use in a service mesh\nthat includes gRPC clients only. Envoy proxies can't use backend services\nthat have this configuration.",
"items": {
"$ref": "BackendServiceLocalityLoadBalancingPolicyConfig"
},
"type": "array"
},
"localityLbPolicy": {
"description": "The load balancing algorithm used within the scope of the locality. The\npossible values are:\n   \n   - ROUND_ROBIN: This is a simple policy in which each healthy\n   backend is selected in round robin order. This is the default.\n   - LEAST_REQUEST: An O(1) algorithm which\n   selects two random healthy hosts and picks the host which has fewer active\n   requests.\n   - RING_HASH: The ring/modulo hash load balancer implements\n   consistent hashing to backends. The algorithm has the property that the\n   addition/removal of a host from a set of N hosts only affects 1/N of the\n   requests.\n   - RANDOM: The load balancer selects a random healthy\n   host.\n   - ORIGINAL_DESTINATION: Backend host is selected\n   based on the client connection metadata, i.e., connections are opened to\n   the same address as the destination address of the incoming connection\n   before the connection was redirected to the load balancer.\n   - MAGLEV: used as a drop in replacement for the ring hash\n   load balancer. Maglev is not as stable as ring hash but has faster table\n   lookup build times and host selection times. For more information about\n   Maglev, see Maglev:\n   A Fast and Reliable Software Network Load Balancer.\n   - WEIGHTED_ROUND_ROBIN: Per-endpoint Weighted Round Robin\n   Load Balancing using weights computed from Backend reported Custom Metrics.\n   If set, the Backend Service responses are expected to contain non-standard\n   HTTP response header field Endpoint-Load-Metrics. The reported\n   metrics to use for computing the weights are specified via thecustomMetrics field.\n   \n   This field is applicable to either:\n      - A regional backend service with the service protocol set to HTTP,\n      HTTPS, HTTP2 or H2C, and load_balancing_scheme set to\n      INTERNAL_MANAGED. \n      - A global backend service with the\n      load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or\n      EXTERNAL_MANAGED.\n   \n   \n   If sessionAffinity is not configured\u2014that is, if session\n   affinity remains at the default value of NONE\u2014then the\n   default value for localityLbPolicy\n   is ROUND_ROBIN. If session affinity is set to a value other\n   than NONE,\n   then the default value for localityLbPolicy isMAGLEV.\n   \n   Only ROUND_ROBIN and RING_HASH are supported\n   when the backend service is referenced by a URL map that is bound to\n   target gRPC proxy that has validateForProxyless field set to true.\n   \n   localityLbPolicy cannot be specified with haPolicy.",
"enum": [
"INVALID_LB_POLICY",
"LEAST_REQUEST",
"MAGLEV",
"ORIGINAL_DESTINATION",
"RANDOM",
"RING_HASH",
"ROUND_ROBIN",
"WEIGHTED_GCP_RENDEZVOUS",
"WEIGHTED_MAGLEV",
"WEIGHTED_ROUND_ROBIN"
],
"enumDescriptions": [
"",
"An O(1) algorithm which selects two random healthy hosts and\npicks the host which has fewer active requests.",
"This algorithm implements consistent hashing to backends. Maglev can be\nused as a drop in replacement for the ring hash load balancer. Maglev is\nnot as stable as ring hash but has faster table lookup build times and\nhost selection times. For more information about Maglev, seeMaglev:\nA Fast and Reliable Software Network Load Balancer.",
"Backend host is selected based on the client connection metadata, i.e.,\nconnections are opened to the same address as the destination address of\nthe incoming connection before the connection was redirected to the load\nbalancer.",
"The load balancer selects a random healthy host.",
"The ring/modulo hash load balancer implements consistent hashing to\nbackends. The algorithm has the property that the addition/removal\nof a host from a set of N hosts only affects 1/N of the requests.",
"This is a simple policy in which each healthy backend is selected\nin round robin order. This is the default.",
"Per-instance weighted Load Balancing via health check reported weights.\nIn internal passthrough network load balancing, it is weighted\nrendezvous hashing.\nThis option is only supported in internal passthrough network load\nbalancing.",
"Per-instance weighted Load Balancing via health check reported weights.\nIf set, the Backend Service must configure a non legacy HTTP-based Health\nCheck, and health check replies are expected to contain non-standard HTTP\nresponse header field X-Load-Balancing-Endpoint-Weight to specify the\nper-instance weights.\nIf set, Load Balancing is weighted based on the\nper-instance weights reported in the last processed health check replies,\nas long as every instance either reported a valid weight or had\nUNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.\nThis option is only supported in Network Load Balancing.",
"Per-endpoint weighted round-robin Load Balancing using weights computed\nfrom Backend reported Custom Metrics. If set, the Backend Service\nresponses are expected to contain non-standard HTTP response header field\nEndpoint-Load-Metrics. The reported metrics\nto use for computing the weights are specified via the\ncustomMetrics fields."
],
"type": "string"
},
"logConfig": {
"$ref": "BackendServiceLogConfig",
"description": "This field denotes the logging options for the load balancer traffic served\nby this backend service. If logging is enabled, logs will be exported to\nStackdriver."
},
"maxStreamDuration": {
"$ref": "Duration",
"description": "Specifies the default maximum duration (timeout) for streams to this\nservice. Duration is computed from the beginning of the stream until the\nresponse has been completely processed, including all retries. A stream\nthat does not complete in this duration is closed.\n\nIf not specified, there will be no timeout limit, i.e. the maximum\nduration is infinite.\n\nThis value can be overridden in the PathMatcher configuration of the\nUrlMap that references this backend service.\n\nThis field is only allowed when the loadBalancingScheme of\nthe backend service is INTERNAL_SELF_MANAGED."
},
"metadatas": {
"additionalProperties": {
"type": "string"
},
"description": "Deployment metadata associated with the resource to be set by a GKE hub\ncontroller and read by the backend RCTH",
"type": "object"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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.\n\nThis field must be set for Internal Passthrough Network Load Balancers when\nthe haPolicy is enabled, and for External Passthrough Network Load\nBalancers when the haPolicy fastIpMove is enabled.\n\nThis field can only be specified when the load balancing scheme is set toINTERNAL, or when the load balancing scheme is set toEXTERNAL and haPolicy fastIpMove is enabled.",
"type": "string"
},
"networkPassThroughLbTrafficPolicy": {
"$ref": "BackendServiceNetworkPassThroughLbTrafficPolicy",
"description": "Configures traffic steering properties of internal passthrough Network\nLoad Balancers.\n\nnetworkPassThroughLbTrafficPolicy cannot be specified with haPolicy."
},
"orchestrationInfo": {
"$ref": "BackendServiceOrchestrationInfo",
"description": "Information about the resource or system that manages the backend service."
},
"outlierDetection": {
"$ref": "OutlierDetection",
"description": "Settings controlling the ejection of unhealthy backend endpoints from the\nload balancing pool of each individual proxy instance that processes the\ntraffic for the given backend service. If not set, this feature is\nconsidered disabled.\n\nResults of the outlier detection algorithm (ejection of endpoints from the\nload balancing pool and returning them back to the pool) are executed\nindependently by each proxy instance of the load balancer. In most cases,\nmore than one proxy instance handles the traffic received by a backend\nservice. Thus, it is possible that an unhealthy endpoint is detected and\nejected by only some of the proxies, and while this happens, other proxies\nmay continue to send requests to the same unhealthy endpoint until they\ndetect and eject the unhealthy endpoint.\n\nApplicable backend endpoints can be:\n   \n   - VM instances in an Instance Group\n   - Endpoints in a Zonal NEG (GCE_VM_IP, GCE_VM_IP_PORT)\n   - Endpoints in a Hybrid Connectivity NEG (NON_GCP_PRIVATE_IP_PORT)\n   - Serverless NEGs, that resolve to Cloud Run, App Engine, or Cloud\n   Functions Services \n   - Private Service Connect NEGs, that resolve to\n   Google-managed regional API endpoints or managed services published using\n   Private Service Connect\n\n\n\nApplicable backend service types can be:\n   \n   - A global backend service with the loadBalancingScheme set to\n   INTERNAL_SELF_MANAGED or EXTERNAL_MANAGED. \n   - A regional backend\n   service with the service protocol set to HTTP, HTTPS, HTTP2 or H2C, and\n   loadBalancingScheme set to INTERNAL_MANAGED or EXTERNAL_MANAGED. Not\n   supported for Serverless NEGs.\n\n\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true."
},
"params": {
"$ref": "BackendServiceParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"port": {
"deprecated": true,
"description": "Deprecated in favor of portName. The TCP port to connect on\nthe backend. The default value is 80.\nFor internal passthrough Network Load Balancers and external passthrough\nNetwork Load Balancers, omit port.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "A named port on a backend instance group representing the port for\ncommunication to the backend VMs in that group. The\nnamed port must be [defined on each backend instance\ngroup](https://cloud.google.com/load-balancing/docs/backend-service#named_ports).\nThis parameter has no meaning if the backends are NEGs. For internal\npassthrough Network Load Balancers and external passthrough Network Load\nBalancers, omit port_name.",
"type": "string"
},
"protocol": {
"description": "The protocol this BackendService uses to communicate\nwith backends.\n\nPossible values are HTTP, HTTPS, HTTP2, H2C, TCP, SSL, UDP or GRPC.\ndepending on the chosen load balancer or Traffic Director configuration.\nRefer to the documentation for the load balancers or for Traffic Director\nfor more information.\n\nMust be set to GRPC when the backend service is referenced by a URL map\nthat is bound to target gRPC proxy.",
"enum": [
"GRPC",
"H2C",
"HTTP",
"HTTP2",
"HTTPS",
"SSL",
"TCP",
"UDP",
"UNSPECIFIED"
],
"enumDescriptions": [
"gRPC (available for Traffic Director).",
"HTTP2 over cleartext",
"",
"HTTP/2 with SSL.",
"",
"TCP proxying with SSL.",
"TCP proxying or TCP pass-through.",
"UDP.",
"If a Backend Service has UNSPECIFIED as its protocol, it can be used with\nany L3/L4 Forwarding Rules."
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional backend service\nresides. This field is not applicable to global backend services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"securityPolicy": {
"description": "[Output Only] The resource URL for the security policy associated with this\nbackend service.",
"type": "string"
},
"securitySettings": {
"$ref": "SecuritySettings",
"description": "This field specifies the security settings that apply to this backend\nservice. This field is applicable to a global backend service with the\nload_balancing_scheme set to INTERNAL_SELF_MANAGED."
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"serviceBindings": {
"description": "URLs of networkservices.ServiceBinding resources.\n\nCan only be set if load balancing scheme is INTERNAL_SELF_MANAGED.\nIf set, lists of backends and health checks must be both empty.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceLbPolicy": {
"description": "URL to networkservices.ServiceLbPolicy resource.\n\nCan only be set if load balancing scheme is EXTERNAL_MANAGED,\nINTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global.",
"type": "string"
},
"sessionAffinity": {
"description": "Type of session affinity to use. The default is NONE.\n\nOnly NONE and HEADER_FIELD are supported\nwhen the backend service is referenced by a URL map that is bound to\ntarget gRPC proxy that has validateForProxyless field set to true.\n\nFor more details, see:\n[Session\nAffinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity).\n\nsessionAffinity cannot be specified with haPolicy.",
"enum": [
"CLIENT_IP",
"CLIENT_IP_NO_DESTINATION",
"CLIENT_IP_PORT_PROTO",
"CLIENT_IP_PROTO",
"GENERATED_COOKIE",
"HEADER_FIELD",
"HTTP_COOKIE",
"NONE",
"STRONG_COOKIE_AFFINITY"
],
"enumDescriptions": [
"2-tuple hash on packet's source and destination IP addresses. Connections\nfrom the same source IP address to the same destination IP address will be\nserved by the same backend VM while that VM remains healthy.",
"1-tuple hash only on packet's source IP address. Connections from the\nsame source IP address will be served by the same backend VM while that VM\nremains healthy. This option can only be used for Internal TCP/UDP\nLoad Balancing.",
"5-tuple hash on packet's source and destination IP addresses, IP protocol,\nand source and destination ports. Connections for the same IP protocol\nfrom the same source IP address and port to the same destination IP address\nand port will be served by the same backend VM while that VM remains\nhealthy. This option cannot be used for HTTP(S) load balancing.",
"3-tuple hash on packet's source and destination IP addresses, and IP\nprotocol. Connections for the same IP protocol from the same source IP\naddress to the same destination IP address will be served by the same\nbackend VM while that VM remains healthy. This option cannot be used for\nHTTP(S) load balancing.",
"Hash based on a cookie generated by the L7 loadbalancer.\nOnly valid for HTTP(S) load balancing.",
"The hash is based on a user specified header field.",
"The hash is based on a user provided cookie.",
"No session affinity. Connections from the same client IP may go\nto any instance in the pool.",
"Strong cookie-based affinity. Connections bearing the same cookie will be\nserved by the same backend VM while that VM remains healthy, as long as the\ncookie has not expired."
],
"type": "string"
},
"strongSessionAffinityCookie": {
"$ref": "BackendServiceHttpCookie",
"description": "Describes the HTTP cookie used for stateful session affinity. This field is\napplicable and required if the sessionAffinity is set toSTRONG_COOKIE_AFFINITY."
},
"subsetting": {
"$ref": "Subsetting",
"description": "subsetting cannot be specified with haPolicy."
},
"timeoutSec": {
"description": "The backend service timeout has a different meaning depending on the\ntype of load balancer. For more information see,\nBackend service settings.\nThe default is 30 seconds.\nThe full range of timeout values allowed goes from 1\nthrough 2,147,483,647 seconds.\n\nThis value can be overridden in the PathMatcher configuration of the\nUrlMap that references this backend service.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.\nInstead, use maxStreamDuration.",
"format": "int32",
"type": "integer"
},
"tlsSettings": {
"$ref": "BackendServiceTlsSettings",
"description": "Configuration for Backend Authenticated TLS and mTLS. May only be specified\nwhen the backend protocol is SSL, HTTPS or HTTP2."
},
"usedBy": {
"description": "Output only. [Output Only] List of resources referencing given backend service.",
"items": {
"$ref": "BackendServiceUsedBy"
},
"readOnly": true,
"type": "array"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": {
"bypassCacheOnRequestHeaders": {
"description": "Bypass the cache when the specified request headers are matched - e.g.\nPragma or Authorization headers. Up to 5 headers can be specified.\nThe cache is bypassed for all cdnPolicy.cacheMode settings.",
"items": {
"$ref": "BackendServiceCdnPolicyBypassCacheOnRequestHeader"
},
"type": "array"
},
"cacheKeyPolicy": {
"$ref": "CacheKeyPolicy",
"description": "The CacheKeyPolicy for this CdnPolicy."
},
"cacheMode": {
"description": "Specifies the cache setting for all responses from this backend.\nThe possible values are:USE_ORIGIN_HEADERS Requires the origin to set valid caching\nheaders to cache content. Responses without these headers will not be\ncached at Google's edge, and will require a full trip to the origin on\nevery request, potentially impacting performance and increasing load on\nthe origin server.FORCE_CACHE_ALL Cache all content, ignoring any \"private\",\n\"no-store\" or \"no-cache\" directives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.CACHE_ALL_STATIC Automatically cache static content,\nincluding common image formats, media (video and audio), and web assets\n(JavaScript and CSS). Requests and responses that are marked as\nuncacheable, as well as dynamic content (including HTML), will not be\ncached.\n\nIf no value is provided for cdnPolicy.cacheMode, it defaults\nto CACHE_ALL_STATIC.",
"enum": [
"CACHE_ALL_STATIC",
"FORCE_CACHE_ALL",
"INVALID_CACHE_MODE",
"USE_ORIGIN_HEADERS"
],
"enumDescriptions": [
"Automatically cache static content, including common image formats,\nmedia (video and audio), and web assets (JavaScript and CSS).\nRequests and responses that are marked as uncacheable, as well as\ndynamic content (including HTML), will not be cached.",
"Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\"\ndirectives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.",
"",
"Requires the origin to set valid caching headers to cache content.\nResponses without these headers will not be cached at Google's edge,\nand will require a full trip to the origin on every request,\npotentially impacting performance and increasing load on the\norigin server."
],
"type": "string"
},
"clientTtl": {
"description": "Specifies a separate client (e.g. browser client) maximum TTL. This is\nused to clamp the max-age (or Expires) value sent to the client.  With\nFORCE_CACHE_ALL, the lesser of client_ttl and default_ttl is used for the\nresponse max-age directive, along with a \"public\" directive.  For\ncacheable content in CACHE_ALL_STATIC mode, client_ttl clamps the max-age\nfrom the origin (if specified), or else sets the response max-age\ndirective to the lesser of the client_ttl and default_ttl, and also\nensures a \"public\" cache-control directive is present.\nIf a client TTL is not specified, a default value (1 hour) will be used.\nThe maximum allowed value is 31,622,400s (1 year).",
"format": "int32",
"type": "integer"
},
"defaultTtl": {
"description": "Specifies the default TTL for cached content served by this origin for\nresponses that do not have an existing valid TTL (max-age or s-maxage).\nSetting a TTL of \"0\" means \"always revalidate\".\nThe value of defaultTTL cannot be set to a value greater than that of\nmaxTTL, but can be equal.\nWhen the cacheMode is set to FORCE_CACHE_ALL, the defaultTTL\nwill overwrite the TTL set in all responses. The maximum allowed value is\n31,622,400s (1 year), noting that infrequently accessed objects may be\nevicted from the cache before the defined TTL.",
"format": "int32",
"type": "integer"
},
"maxTtl": {
"description": "Specifies the maximum allowed TTL for cached content served by this\norigin.\nCache directives that attempt to set a max-age or s-maxage higher than\nthis, or an Expires header more than maxTTL seconds in the future will\nbe capped at the value of maxTTL, as if it were the value of an\ns-maxage Cache-Control directive.\nHeaders sent to the client will not be modified.\nSetting a TTL of \"0\" means \"always revalidate\".\nThe maximum allowed value is 31,622,400s (1 year), noting that\ninfrequently accessed objects may be evicted from the cache before\nthe defined TTL.",
"format": "int32",
"type": "integer"
},
"negativeCaching": {
"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the cache mode is set to CACHE_ALL_STATIC or USE_ORIGIN_HEADERS,\nnegative caching applies to responses with the specified response code\nthat lack any Cache-Control, Expires, or Pragma: no-cache directives.\nWhen the cache mode is set to FORCE_CACHE_ALL, negative caching applies\nto all responses with the specified response code, and override any\ncaching headers.\nBy default, Cloud CDN will apply the following default TTLs to these\nstatus codes:\nHTTP 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\nHTTP 404 (Not Found), 410 (Gone),\n451 (Unavailable For Legal Reasons): 120s\nHTTP 405 (Method Not Found), 501 (Not Implemented): 60s.\nThese defaults can be overridden in negative_caching_policy.",
"type": "boolean"
},
"negativeCachingPolicy": {
"description": "Sets a cache TTL for the specified HTTP status code.\nnegative_caching must be enabled to configure negative_caching_policy.\nOmitting the policy and leaving negative_caching enabled will use\nCloud CDN's default cache TTLs.\nNote that when specifying an explicit negative_caching_policy, you\nshould take care to specify a cache TTL for all response codes\nthat you wish to cache. Cloud CDN will not apply any default\nnegative caching when a policy exists.",
"items": {
"$ref": "BackendServiceCdnPolicyNegativeCachingPolicy"
},
"type": "array"
},
"requestCoalescing": {
"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin.",
"type": "boolean"
},
"serveWhileStale": {
"description": "Serve existing content from the cache (if available) when revalidating\ncontent with the origin, or when an error is encountered when refreshing\nthe cache.\nThis setting defines the default \"max-stale\" duration for any cached\nresponses that do not specify a max-stale directive. Stale responses that\nexceed the TTL configured here will not be served. The default limit\n(max-stale) is 86400s (1 day), which will allow stale content to be\nserved up to this limit beyond the max-age (or s-maxage) of a cached\nresponse.\nThe maximum allowed value is 604800 (1 week).\nSet this to zero (0) to disable serve-while-stale.",
"format": "int32",
"type": "integer"
},
"signedUrlCacheMaxAgeSec": {
"description": "Maximum number of seconds the response to a signed URL request will be\nconsidered fresh. After this time period, the response will be\nrevalidated before being served. Defaults to 1hr (3600s).  When serving\nresponses to signed URL requests, Cloud CDN will internally behave as\nthough all responses from this backend had a \"Cache-Control:\npublic, max-age=[TTL]\" header, regardless of any existing\nCache-Control header. The actual headers served in responses will not be\naltered.",
"format": "int64",
"type": "string"
},
"signedUrlKeyNames": {
"description": "[Output Only] Names of the keys for signing request URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackendServiceCdnPolicyBypassCacheOnRequestHeader": {
"description": "Bypass the cache when the specified request headers are present,\ne.g. Pragma or Authorization headers. Values are case insensitive.\nThe presence of such a header overrides the cache_mode setting.",
"id": "BackendServiceCdnPolicyBypassCacheOnRequestHeader",
"properties": {
"headerName": {
"description": "The header field name to match on when bypassing cache.\nValues are case-insensitive.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceCdnPolicyNegativeCachingPolicy": {
"description": "Specify CDN TTLs for response error codes.",
"id": "BackendServiceCdnPolicyNegativeCachingPolicy",
"properties": {
"code": {
"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
"format": "int32",
"type": "integer"
},
"ttl": {
"description": "The TTL (in seconds) for which to cache responses with the\ncorresponding status code.\nThe maximum allowed value is 1800s (30 minutes), noting that\ninfrequently accessed objects may be evicted from the cache before the\ndefined TTL.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"BackendServiceConnectionTrackingPolicy": {
"description": "Connection Tracking configuration for this BackendService.",
"id": "BackendServiceConnectionTrackingPolicy",
"properties": {
"connectionPersistenceOnUnhealthyBackends": {
"description": "Specifies connection persistence when backends are unhealthy. The default\nvalue is DEFAULT_FOR_PROTOCOL.\n\nIf set to DEFAULT_FOR_PROTOCOL, the existing connections\npersist on unhealthy backends only for connection-oriented protocols\n(TCP and SCTP) and only if the Tracking Mode isPER_CONNECTION (default tracking mode) or the Session\nAffinity is configured for 5-tuple. They do not persist forUDP.\n\nIf set to NEVER_PERSIST, after a backend becomes unhealthy,\nthe existing connections on the unhealthy backend are never persisted on\nthe unhealthy backend. They are always diverted to newly selected healthy\nbackends (unless all backends are unhealthy).\n\nIf set to ALWAYS_PERSIST, existing connections always\npersist on unhealthy backends regardless of protocol and session\naffinity. It is generally not recommended to use this mode overriding the\ndefault.\n\nFor more details, see [Connection Persistence for Network Load\nBalancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence)\nand [Connection Persistence for Internal TCP/UDP Load\nBalancing](https://cloud.google.com/load-balancing/docs/internal#connection-persistence).",
"enum": [
"ALWAYS_PERSIST",
"DEFAULT_FOR_PROTOCOL",
"NEVER_PERSIST"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"enableStrongAffinity": {
"description": "Enable Strong Session Affinity for external passthrough Network Load\nBalancers. This option is not available publicly.",
"type": "boolean"
},
"idleTimeoutSec": {
"description": "Specifies how long to keep a Connection Tracking entry while there is no\nmatching traffic (in seconds).\n\nFor internal passthrough Network Load Balancers:\n   \n   - The minimum (default) is 10 minutes and the maximum is 16 hours.\n   - It can be set only if Connection Tracking is less than 5-tuple\n   (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION,CLIENT_IP or CLIENT_IP_PROTO, and Tracking\n   Mode is PER_SESSION).\n\n\n\nFor external passthrough Network Load Balancers the default is 60\nseconds. This option is not available publicly.",
"format": "int32",
"type": "integer"
},
"trackingMode": {
"description": "Specifies the key used for connection tracking. There are two\noptions:\n   \n   - PER_CONNECTION: This is the default mode. The Connection\n   Tracking is performed as per the Connection Key (default Hash Method) for\n   the specific protocol.\n   - PER_SESSION: The Connection Tracking is performed as per\n   the configured Session Affinity. It matches the configured Session\n   Affinity.\n\n\n\nFor more details, see [Tracking Mode for Network Load\nBalancing](https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode)\nand [Tracking Mode for Internal TCP/UDP Load\nBalancing](https://cloud.google.com/load-balancing/docs/internal#tracking-mode).",
"enum": [
"INVALID_TRACKING_MODE",
"PER_CONNECTION",
"PER_SESSION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"BackendServiceCustomMetric": {
"description": "Custom Metrics are used for WEIGHTED_ROUND_ROBIN\nlocality_lb_policy.",
"id": "BackendServiceCustomMetric",
"properties": {
"dryRun": {
"description": "If true, the metric data is not used for load balancing.",
"type": "boolean"
},
"name": {
"description": "Name of a custom utilization signal. The name must be 1-64 characters\nlong and match the regular expression\n`[a-z]([-_.a-z0-9]*[a-z0-9])?` which means that the\nfirst character must be a lowercase letter, and all following\ncharacters must be a dash, period, underscore, lowercase letter, or\ndigit, except the last character, which cannot be a dash, period, or\nunderscore. For usage guidelines, see Custom Metrics balancing mode. This\nfield can only be used for a global or regional backend service with the\nloadBalancingScheme set to EXTERNAL_MANAGED,INTERNAL_MANAGED INTERNAL_SELF_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceFailoverPolicy": {
"description": "For load balancers that have configurable\nfailover:\n[Internal passthrough Network Load\nBalancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)\nand [external passthrough\nNetwork Load\nBalancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).\nOn failover or failback, this field indicates whether connection draining\nwill be honored. Google Cloud has a fixed connection draining timeout of\n10 minutes. A setting of true terminates existing TCP\nconnections to the active pool during failover and failback, immediately\ndraining traffic. A setting of false allows existing TCP\nconnections to persist, even on VMs no longer in the active pool, for up\nto the duration of the connection draining timeout (10 minutes).",
"id": "BackendServiceFailoverPolicy",
"properties": {
"disableConnectionDrainOnFailover": {
"description": "This can be set to true if the protocol isTCP, UDP, or UNSPECIFIED.\n\nThe default is false.",
"type": "boolean"
},
"dropTrafficIfUnhealthy": {
"description": "If set to true, connections to the\nload balancer are dropped when all primary and all backup backend VMs are\nunhealthy.If set to false, connections are distributed\namong all primary VMs when all primary and all backup backend VMs are\n unhealthy.\nFor load balancers that have configurable\nfailover:\n[Internal passthrough\nNetwork Load\nBalancers](https://cloud.google.com/load-balancing/docs/internal/failover-overview)\nand [external passthrough\nNetwork Load\nBalancers](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).\nThe default is false.",
"type": "boolean"
},
"failoverRatio": {
"description": "The value of the field must be in the range[0, 1]. If the value is 0, the load balancer performs a\nfailover when the number of healthy primary VMs equals zero.\nFor all other values, the load balancer performs a failover when the\ntotal number of healthy primary VMs is less than this ratio.\nFor load balancers that have configurable\nfailover:\n[Internal TCP/UDP Load\nBalancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview)\nand [external TCP/UDP Load\nBalancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview).",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendServiceGroupHealth": {
"id": "BackendServiceGroupHealth",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata defined as annotations on the network endpoint group.",
"type": "object"
},
"healthStatus": {
"description": "Health state of the backend instances or endpoints in requested instance or\nnetwork endpoint group, determined based on configured health checks.",
"items": {
"$ref": "HealthStatus"
},
"type": "array"
},
"kind": {
"default": "compute#backendServiceGroupHealth",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#backendServiceGroupHealth for the health of backend\nservices.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BackendServiceHAPolicy": {
"id": "BackendServiceHAPolicy",
"properties": {
"fastIPMove": {
"description": "Specifies whether fast IP move is enabled, and if so, the mechanism to\nachieve it.\n\nSupported values are:\n   \n   - DISABLED: Fast IP Move is disabled. You can only use the\n   haPolicy.leader API to update the leader.\n   - >GARP_RA: Provides a method to very quickly define a new network\n   endpoint as the leader. This method is faster than updating the leader\n   using the haPolicy.leader API. Fast IP move works as follows: The VM\n   hosting the network endpoint that should become the new leader sends\n   either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router\n   Advertisement(RA) packet (IPv6).  Google Cloud immediately but\n   temporarily associates the forwarding rule IP address with that VM, and\n   both new and in-flight packets are quickly delivered to that VM.\n\n\n\nNote the important properties of the Fast IP Move functionality:\n   \n   - The GARP/RA-initiated re-routing stays active for approximately 20\n   minutes. After triggering fast failover, you must also\n   appropriately set the haPolicy.leader.\n   -  The new leader instance should continue to send GARP/RA packets\n   periodically every 10 seconds until at least 10 minutes after updating\n   the haPolicy.leader (but stop immediately if it is no longer the leader).\n   - After triggering a fast failover, we recommend that you wait at least\n   3 seconds before sending another GARP/RA packet from a different VM\n   instance to avoid race conditions.\n   - Don't send GARP/RA packets from different VM\n   instances at the same time. If multiple instances continue to send\n   GARP/RA packets, traffic might be routed to different destinations in an\n   alternating order. This condition ceases when a single instance\n   issues a GARP/RA packet.\n   - The GARP/RA request always takes priority over the leader API.\n   Using the haPolicy.leader API to change the leader to a different\n   instance will have no effect until the GARP/RA request becomes\n   inactive.\n   - The GARP/RA packets should follow the GARP/RA\n   Packet Specifications..\n   -  When multiple forwarding rules refer to a regional backend service,\n   you need only send a GARP or RA packet for a single forwarding rule\n   virtual IP. The virtual IPs for all forwarding rules targeting the same\n   backend service will also be moved to the sender of the GARP or RA\n   packet. \n\n\n\nThe following are the Fast IP Move limitations (that is, when fastIPMove\nis not DISABLED):\n   \n   - Multiple forwarding rules cannot use the same IP address if one of\n   them refers to a regional backend service with fastIPMove.\n   - The regional backend service must set the network field, and all\n   NEGs must belong to that network. However, individual\n   NEGs can belong to different subnetworks of that network. \n   - The maximum number of network endpoints across all backends of a\n   backend service with fastIPMove is 32.\n   - The maximum number of backend services with fastIPMove that can have\n   the same network endpoint attached to one of its backends is 64.\n   - The maximum number of backend services with fastIPMove in a VPC in a\n   region is 64.\n   - The network endpoints that are attached to a backend of a backend\n   service with fastIPMove cannot resolve to Gen3+ machines for IPv6.\n   - Traffic directed to the leader by a static route next hop will not be\n   redirected to a new leader by fast failover. Such traffic will only be\n   redirected once an haPolicy.leader update has taken effect. Only traffic\n   to the forwarding rule's virtual IP will be redirected to a new leader by\n   fast failover.\n\n\nhaPolicy.fastIPMove can be set only at backend service creation time.\nOnce set, it cannot be updated.\n\nBy default, fastIpMove is set to DISABLED.",
"enum": [
"DISABLED",
"GARP_RA"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"leader": {
"$ref": "BackendServiceHAPolicyLeader",
"description": "Selects one of the network endpoints attached to the backend NEGs of\nthis service as the active endpoint (the leader) that receives all\ntraffic.\n\nWhen the leader changes, there is no connection draining to persist\nexisting connections on the old leader.\n\nYou are responsible for selecting a suitable endpoint as the\nleader. For example, preferring a healthy endpoint over unhealthy ones.\nNote that this service does not track backend endpoint health, and\nselects the configured leader unconditionally."
}
},
"type": "object"
},
"BackendServiceHAPolicyLeader": {
"id": "BackendServiceHAPolicyLeader",
"properties": {
"backendGroup": {
"description": "A fully-qualified URL (starting with https://www.googleapis.com/)\nof the zonal Network Endpoint Group (NEG) with `GCE_VM_IP` endpoints\nthat the leader is attached to.\n\nThe leader's backendGroup must already be specified as a backend of\nthis backend service. Removing a backend that is designated as the\nleader's backendGroup is not permitted.",
"type": "string"
},
"networkEndpoint": {
"$ref": "BackendServiceHAPolicyLeaderNetworkEndpoint",
"description": "The network endpoint within the leader.backendGroup that is\ndesignated as the leader.\n\nThis network endpoint cannot be detached from the NEG specified in\nthe haPolicy.leader.backendGroup until the leader is updated with\nanother network endpoint, or the leader is removed from the haPolicy."
}
},
"type": "object"
},
"BackendServiceHAPolicyLeaderNetworkEndpoint": {
"id": "BackendServiceHAPolicyLeaderNetworkEndpoint",
"properties": {
"instance": {
"description": "The name of the VM instance of the leader network endpoint. The\ninstance must already be attached to the NEG specified in the\nhaPolicy.leader.backendGroup.\n\nThe name must be 1-63 characters long, and comply with RFC1035.\nAuthorization requires the following IAM permission on the\nspecified resource instance: compute.instances.use",
"type": "string"
}
},
"type": "object"
},
"BackendServiceHttpCookie": {
"description": "The HTTP cookie used for stateful session affinity.",
"id": "BackendServiceHttpCookie",
"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"
},
"BackendServiceIAP": {
"description": "Identity-Aware Proxy",
"id": "BackendServiceIAP",
"properties": {
"enabled": {
"description": "Whether the serving infrastructure will authenticate and authorize all\nincoming requests.",
"type": "boolean"
},
"oauth2ClientId": {
"description": "OAuth2 client ID to use for the authentication flow.",
"type": "string"
},
"oauth2ClientSecret": {
"description": "OAuth2 client secret to use for the authentication flow.\nFor security reasons, this value cannot be retrieved via the API.\nInstead, the SHA-256 hash of the value is returned in the\noauth2ClientSecretSha256 field.\n\n@InputOnly",
"type": "string"
},
"oauth2ClientSecretSha256": {
"description": "Output only. [Output Only] SHA256 hash value for the field oauth2_client_secret above.",
"readOnly": true,
"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. [Output Only] Type of resource. Alwayscompute#backendServiceList for lists of backend services.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendServiceListUsable": {
"description": "Contains a list of usable BackendService resources.",
"id": "BackendServiceListUsable",
"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#usableBackendServiceList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#usableBackendServiceList for lists of usable backend\nservices.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BackendServiceLocalityLoadBalancingPolicyConfig": {
"description": "Container for either a built-in LB policy supported by gRPC or Envoy or\na custom one implemented by the end user.",
"id": "BackendServiceLocalityLoadBalancingPolicyConfig",
"properties": {
"customPolicy": {
"$ref": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy"
},
"policy": {
"$ref": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy"
}
},
"type": "object"
},
"BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy": {
"description": "The configuration for a custom policy implemented by the user and\ndeployed with the client.",
"id": "BackendServiceLocalityLoadBalancingPolicyConfigCustomPolicy",
"properties": {
"data": {
"description": "An optional, arbitrary JSON object with configuration data, understood\nby a locally installed custom policy implementation.",
"type": "string"
},
"name": {
"description": "Identifies the custom policy.\n\nThe value should match the name of a custom implementation registered\non the gRPC clients. It should follow protocol buffer message naming\nconventions and include the full path (for example,\nmyorg.CustomLbPolicy). The maximum length is 256 characters.\n\nDo not specify the same custom policy more than once for a\nbackend. If you do, the configuration is rejected.\n\nFor an example of how to use this field, seeUse\na custom policy.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceLocalityLoadBalancingPolicyConfigPolicy": {
"description": "The configuration for a built-in load balancing policy.",
"id": "BackendServiceLocalityLoadBalancingPolicyConfigPolicy",
"properties": {
"name": {
"description": "The name of a locality load-balancing policy. Valid values include\nROUND_ROBIN and, for Java clients, LEAST_REQUEST. For information\nabout these values, see the description of localityLbPolicy.\n\nDo not specify the same policy more than once for a\nbackend. If you do, the configuration is rejected.",
"enum": [
"INVALID_LB_POLICY",
"LEAST_REQUEST",
"MAGLEV",
"ORIGINAL_DESTINATION",
"RANDOM",
"RING_HASH",
"ROUND_ROBIN",
"WEIGHTED_GCP_RENDEZVOUS",
"WEIGHTED_MAGLEV",
"WEIGHTED_ROUND_ROBIN"
],
"enumDescriptions": [
"",
"An O(1) algorithm which selects two random healthy hosts and\npicks the host which has fewer active requests.",
"This algorithm implements consistent hashing to backends. Maglev can be\nused as a drop in replacement for the ring hash load balancer. Maglev is\nnot as stable as ring hash but has faster table lookup build times and\nhost selection times. For more information about Maglev, seeMaglev:\nA Fast and Reliable Software Network Load Balancer.",
"Backend host is selected based on the client connection metadata, i.e.,\nconnections are opened to the same address as the destination address of\nthe incoming connection before the connection was redirected to the load\nbalancer.",
"The load balancer selects a random healthy host.",
"The ring/modulo hash load balancer implements consistent hashing to\nbackends. The algorithm has the property that the addition/removal\nof a host from a set of N hosts only affects 1/N of the requests.",
"This is a simple policy in which each healthy backend is selected\nin round robin order. This is the default.",
"Per-instance weighted Load Balancing via health check reported weights.\nIn internal passthrough network load balancing, it is weighted\nrendezvous hashing.\nThis option is only supported in internal passthrough network load\nbalancing.",
"Per-instance weighted Load Balancing via health check reported weights.\nIf set, the Backend Service must configure a non legacy HTTP-based Health\nCheck, and health check replies are expected to contain non-standard HTTP\nresponse header field X-Load-Balancing-Endpoint-Weight to specify the\nper-instance weights.\nIf set, Load Balancing is weighted based on the\nper-instance weights reported in the last processed health check replies,\nas long as every instance either reported a valid weight or had\nUNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight.\nThis option is only supported in Network Load Balancing.",
"Per-endpoint weighted round-robin Load Balancing using weights computed\nfrom Backend reported Custom Metrics. If set, the Backend Service\nresponses are expected to contain non-standard HTTP response header field\nEndpoint-Load-Metrics. The reported metrics\nto use for computing the weights are specified via the\ncustomMetrics fields."
],
"type": "string"
}
},
"type": "object"
},
"BackendServiceLogConfig": {
"description": "The available logging options for the load balancer traffic served by this\nbackend service.",
"id": "BackendServiceLogConfig",
"properties": {
"enable": {
"description": "Denotes whether to enable logging for the load balancer\ntraffic served by this backend service. The default value is false.",
"type": "boolean"
},
"optionalFields": {
"description": "This field can only be specified if logging is enabled for this backend\nservice and \"logConfig.optionalMode\" was set to CUSTOM. Contains a list\nof optional fields you want to include in the logs. For example:\nserverInstance, serverGkeDetails.cluster,\nserverGkeDetails.pod.podNamespace",
"items": {
"type": "string"
},
"type": "array"
},
"optionalMode": {
"description": "This field can only be specified if logging is enabled for this backend\nservice. Configures whether all, none or a subset of optional fields\nshould be added to the reported logs. One of [INCLUDE_ALL_OPTIONAL,\nEXCLUDE_ALL_OPTIONAL, CUSTOM]. Default is EXCLUDE_ALL_OPTIONAL.",
"enum": [
"CUSTOM",
"EXCLUDE_ALL_OPTIONAL",
"INCLUDE_ALL_OPTIONAL"
],
"enumDescriptions": [
"A subset of optional fields.",
"None optional fields.",
"All optional fields."
],
"type": "string"
},
"sampleRate": {
"description": "This field can only be specified if logging is enabled for this backend\nservice. The value of the field must be in [0, 1]. This configures the\nsampling rate of requests to the load balancer where 1.0 means all logged\nrequests are reported and 0.0 means no logged requests are reported. The\ndefault value is 1.0.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendServiceNetworkPassThroughLbTrafficPolicy": {
"id": "BackendServiceNetworkPassThroughLbTrafficPolicy",
"properties": {
"zonalAffinity": {
"$ref": "BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity",
"description": "When configured, new connections are load balanced across healthy backend\nendpoints in the local zone."
}
},
"type": "object"
},
"BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity": {
"id": "BackendServiceNetworkPassThroughLbTrafficPolicyZonalAffinity",
"properties": {
"spillover": {
"description": "This field indicates whether zonal affinity is enabled or not. The\npossible values are:\n   \n   - ZONAL_AFFINITY_DISABLED: Default Value. Zonal Affinity\n   is disabled. The load balancer distributes new connections to all\n   healthy backend endpoints across all zones.\n   - ZONAL_AFFINITY_STAY_WITHIN_ZONE: Zonal Affinity is\n   enabled. The load balancer distributes new connections to all healthy\n   backend endpoints in the local zone only. If there are no healthy\n   backend endpoints in the local zone, the load balancer distributes\n   new connections to all backend endpoints in the local zone.\n   - ZONAL_AFFINITY_SPILL_CROSS_ZONE: Zonal Affinity is\n   enabled. The load balancer distributes new connections to all healthy\n   backend endpoints in the local zone only. If there aren't enough\n   healthy backend endpoints in the local zone, the load balancer\n   distributes new connections to all healthy backend endpoints across all\n   zones.",
"enum": [
"ZONAL_AFFINITY_DISABLED",
"ZONAL_AFFINITY_SPILL_CROSS_ZONE",
"ZONAL_AFFINITY_STAY_WITHIN_ZONE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"spilloverRatio": {
"description": "The value of the field must be in [0, 1]. When the ratio of the count\nof healthy backend endpoints in a zone to the count of backend\nendpoints in that same zone is equal to or above this threshold, the\nload balancer distributes new connections to all healthy endpoints in\nthe local zone only. When the ratio of the count of healthy backend\nendpoints in a zone to the count of backend endpoints in that same\nzone is below this threshold, the load balancer distributes all new\nconnections to all healthy endpoints across all zones.",
"format": "float",
"type": "number"
}
},
"type": "object"
},
"BackendServiceOrchestrationInfo": {
"description": "A message containing information about the resource or system that manages\nthe backend service.",
"id": "BackendServiceOrchestrationInfo",
"properties": {
"resourceUri": {
"description": "The resource URI of the resource or system that manages the backend\nservice.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceParams": {
"description": "Additional Backend Service parameters.",
"id": "BackendServiceParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"BackendServiceReference": {
"id": "BackendServiceReference",
"properties": {
"backendService": {
"type": "string"
}
},
"type": "object"
},
"BackendServiceTlsSettings": {
"id": "BackendServiceTlsSettings",
"properties": {
"authenticationConfig": {
"description": "Reference to the BackendAuthenticationConfig resource from the\nnetworksecurity.googleapis.com namespace. Can be used in authenticating\nTLS connections to the backend, as specified by the authenticationMode\nfield. Can only be specified if authenticationMode is not NONE.",
"type": "string"
},
"sni": {
"description": "Server Name Indication - see RFC3546 section 3.1. If set, the load\nbalancer sends this string as the SNI hostname in the TLS connection to\nthe backend, and requires that this string match a Subject Alternative\nName (SAN) in the backend's server certificate. With a Regional Internet\nNEG backend, if the SNI is specified here, the load balancer uses it\nregardless of whether the Regional Internet NEG is specified with FQDN or\nIP address and port. When both sni and subjectAltNames[] are specified,\nthe load balancer matches the backend certificate's SAN only to\nsubjectAltNames[].",
"type": "string"
},
"subjectAltNames": {
"description": "A list of Subject Alternative Names (SANs) that the Load Balancer\nverifies during a TLS handshake with the backend. When the server\npresents its X.509 certificate to the Load Balancer, the Load Balancer\ninspects the certificate's SAN field, and requires that at least one SAN\nmatch one of the subjectAltNames in the list. This field is limited to 5\nentries. When both sni and subjectAltNames[] are specified, the load\nbalancer matches the backend certificate's SAN only to subjectAltNames[].",
"items": {
"$ref": "BackendServiceTlsSettingsSubjectAltName"
},
"type": "array"
}
},
"type": "object"
},
"BackendServiceTlsSettingsSubjectAltName": {
"description": "A Subject Alternative Name that the load balancer matches against the SAN\nfield in the TLS certificate provided by the backend, specified as either\na DNS name or a URI, in accordance with RFC 5280 4.2.1.6",
"id": "BackendServiceTlsSettingsSubjectAltName",
"properties": {
"dnsName": {
"description": "The SAN specified as a DNS Name.",
"type": "string"
},
"uniformResourceIdentifier": {
"description": "The SAN specified as a URI.",
"type": "string"
}
},
"type": "object"
},
"BackendServiceUsedBy": {
"id": "BackendServiceUsedBy",
"properties": {
"reference": {
"description": "Output only. [Output Only] Server-defined URL for resources referencing given\nBackendService like UrlMaps, TargetTcpProxies, TargetSslProxies\nand ForwardingRule.",
"readOnly": true,
"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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"BfdPacket": {
"id": "BfdPacket",
"properties": {
"authenticationPresent": {
"description": "The Authentication Present bit of the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"type": "boolean"
},
"controlPlaneIndependent": {
"description": "The Control Plane Independent bit of the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"type": "boolean"
},
"demand": {
"description": "The demand bit of the BFD packet. This is specified in section 4.1 ofRFC5880",
"type": "boolean"
},
"diagnostic": {
"description": "The diagnostic code specifies the local system's reason for the last change\nin session state. This allows remote systems to determine the reason that\nthe previous session failed, for example. These diagnostic codes are\nspecified in section 4.1 ofRFC5880",
"enum": [
"ADMINISTRATIVELY_DOWN",
"CONCATENATED_PATH_DOWN",
"CONTROL_DETECTION_TIME_EXPIRED",
"DIAGNOSTIC_UNSPECIFIED",
"ECHO_FUNCTION_FAILED",
"FORWARDING_PLANE_RESET",
"NEIGHBOR_SIGNALED_SESSION_DOWN",
"NO_DIAGNOSTIC",
"PATH_DOWN",
"REVERSE_CONCATENATED_PATH_DOWN"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"final": {
"description": "The Final bit of the BFD packet. This is specified in section 4.1 ofRFC5880",
"type": "boolean"
},
"length": {
"description": "The length of the BFD Control packet in bytes. This is specified in section\n4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"minEchoRxIntervalMs": {
"description": "The Required Min Echo RX Interval value in the BFD packet. This is\nspecified in section 4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"minRxIntervalMs": {
"description": "The Required Min RX Interval value in the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"minTxIntervalMs": {
"description": "The Desired Min TX Interval value in the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"multiplier": {
"description": "The detection time multiplier of the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"multipoint": {
"description": "The multipoint bit of the BFD packet. This is specified in section 4.1 ofRFC5880",
"type": "boolean"
},
"myDiscriminator": {
"description": "The My Discriminator value in the BFD packet. This is specified in section\n4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
},
"poll": {
"description": "The Poll bit of the BFD packet. This is specified in section 4.1 ofRFC5880",
"type": "boolean"
},
"state": {
"description": "The current BFD session state as seen by the transmitting system. These\nstates are specified in section 4.1 ofRFC5880",
"enum": [
"ADMIN_DOWN",
"DOWN",
"INIT",
"STATE_UNSPECIFIED",
"UP"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"version": {
"description": "The version number of the BFD protocol, as specified in section 4.1 ofRFC5880.",
"format": "uint32",
"type": "integer"
},
"yourDiscriminator": {
"description": "The Your Discriminator value in the BFD packet. This is specified in\nsection 4.1 ofRFC5880",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"BfdStatus": {
"description": "Next free: 15",
"id": "BfdStatus",
"properties": {
"bfdSessionInitializationMode": {
"description": "The BFD session initialization mode for this BGP peer.\nIf set to ACTIVE, the Cloud Router will initiate the BFD session for\nthis BGP peer. If set to PASSIVE, the Cloud Router will wait for the\npeer router to initiate the BFD session for this BGP peer. If set to\nDISABLED, BFD is disabled for this BGP peer.",
"enum": [
"ACTIVE",
"DISABLED",
"PASSIVE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"configUpdateTimestampMicros": {
"description": "Unix timestamp of the most recent config update.",
"format": "int64",
"type": "string"
},
"controlPacketCounts": {
"$ref": "BfdStatusPacketCounts",
"description": "Control packet counts for the current BFD session."
},
"controlPacketIntervals": {
"description": "Inter-packet time interval statistics for control packets.",
"items": {
"$ref": "PacketIntervals"
},
"type": "array"
},
"localDiagnostic": {
"description": "The diagnostic code specifies the local system's reason for the last change\nin session state. This allows remote systems to determine the reason that\nthe previous session failed, for example. These diagnostic codes are\nspecified in section 4.1 ofRFC5880",
"enum": [
"ADMINISTRATIVELY_DOWN",
"CONCATENATED_PATH_DOWN",
"CONTROL_DETECTION_TIME_EXPIRED",
"DIAGNOSTIC_UNSPECIFIED",
"ECHO_FUNCTION_FAILED",
"FORWARDING_PLANE_RESET",
"NEIGHBOR_SIGNALED_SESSION_DOWN",
"NO_DIAGNOSTIC",
"PATH_DOWN",
"REVERSE_CONCATENATED_PATH_DOWN"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"localState": {
"description": "The current BFD session state as seen by the transmitting system. These\nstates are specified in section 4.1 ofRFC5880",
"enum": [
"ADMIN_DOWN",
"DOWN",
"INIT",
"STATE_UNSPECIFIED",
"UP"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"negotiatedLocalControlTxIntervalMs": {
"description": "Negotiated transmit interval for control packets.",
"format": "uint32",
"type": "integer"
},
"rxPacket": {
"$ref": "BfdPacket",
"description": "The most recent Rx control packet for this BFD session."
},
"txPacket": {
"$ref": "BfdPacket",
"description": "The most recent Tx control packet for this BFD session."
},
"uptimeMs": {
"description": "Session uptime in milliseconds. Value will be 0 if session is not up.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"BfdStatusPacketCounts": {
"id": "BfdStatusPacketCounts",
"properties": {
"numRx": {
"description": "Number of packets received since the beginning of the current BFD\nsession.",
"format": "uint32",
"type": "integer"
},
"numRxRejected": {
"description": "Number of packets received that were rejected because of errors since the\nbeginning of the current BFD session.",
"format": "uint32",
"type": "integer"
},
"numRxSuccessful": {
"description": "Number of packets received that were successfully processed since the\nbeginning of the current BFD session.",
"format": "uint32",
"type": "integer"
},
"numTx": {
"description": "Number of packets transmitted since the beginning of the current BFD\nsession.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"BgpRoute": {
"id": "BgpRoute",
"properties": {
"asPaths": {
"description": "Output only. [Output only] AS-PATH for the route",
"items": {
"$ref": "BgpRouteAsPath"
},
"readOnly": true,
"type": "array"
},
"communities": {
"description": "Output only. [Output only] BGP communities in human-readable A:B format.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"destination": {
"$ref": "BgpRouteNetworkLayerReachabilityInformation",
"description": "Output only. [Output only] Destination IP range for the route, in human-readable CIDR\nformat",
"readOnly": true
},
"med": {
"description": "Output only. [Output only] BGP multi-exit discriminator",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"origin": {
"description": "Output only. [Output only] BGP origin (EGP, IGP or INCOMPLETE)",
"enum": [
"BGP_ORIGIN_EGP",
"BGP_ORIGIN_IGP",
"BGP_ORIGIN_INCOMPLETE"
],
"enumDescriptions": [
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BgpRouteAsPath": {
"id": "BgpRouteAsPath",
"properties": {
"asns": {
"description": "Output only. [Output only] ASNs in the path segment. When type is SEQUENCE, these are\nordered.",
"items": {
"format": "int32",
"type": "integer"
},
"readOnly": true,
"type": "array"
},
"asns32": {
"description": "Output only. [Output only] ASNs in the path segment. This field is for better\nsupport of 32 bit ASNs as the other asns field suffers from overflow when\nthe ASN is larger. When type is SEQUENCE, these are ordered.",
"items": {
"format": "uint32",
"type": "integer"
},
"readOnly": true,
"type": "array"
},
"type": {
"description": "Output only. [Output only] Type of AS-PATH segment (SEQUENCE or SET)",
"enum": [
"AS_PATH_TYPE_SEQUENCE",
"AS_PATH_TYPE_SET"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BgpRouteNetworkLayerReachabilityInformation": {
"description": "Network Layer Reachability Information (NLRI) for a route.",
"id": "BgpRouteNetworkLayerReachabilityInformation",
"properties": {
"pathId": {
"description": "If the BGP session supports multiple paths (RFC 7911), the path\nidentifier for this route.",
"format": "uint32",
"type": "integer"
},
"prefix": {
"description": "Human readable CIDR notation for a prefix. E.g. 10.42.0.0/16.",
"type": "string"
}
},
"type": "object"
},
"Binding": {
"description": "Associates `members`, or principals, 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\ncurrent request.\n\nIf the condition evaluates to `false`, then this binding does not apply to\nthe current request. However, a different role binding might grant the same\nrole to one or more of the principals in this binding.\n\nTo learn which resources support conditions in their IAM policies, see the\n[IAM\ndocumentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the principals requesting access for a Google Cloud resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n   on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n   who is authenticated with a Google account or a service account.\n   Does not include identities that come from external identity providers\n   (IdPs) through identity federation.\n\n* `user:{emailid}`: An email address that represents a specific Google\n   account. For example, `alice@example.com` .\n\n\n* `serviceAccount:{emailid}`: An email address that represents a Google\n   service account. For example,\n   `my-other-app@appspot.gserviceaccount.com`.\n\n* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An\n   identifier for a\n   [Kubernetes service\n   account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).\n   For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n   For example, `admins@example.com`.\n\n\n* `domain:{domain}`: The G Suite domain (primary) that represents all the\n   users of that domain. For example, `google.com` or `example.com`.\n\n\n\n\n* `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n  A single identity in a workforce identity pool.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:\n  All workforce identities in a group.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n  All workforce identities with a specific attribute value.\n\n* `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`:\n  All identities in a workforce identity pool.\n\n* `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`:\n  A single identity in a workload identity pool.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`:\n  A workload identity pool group.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:\n  All identities in a workload identity pool with a certain attribute.\n\n* `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`:\n  All identities in a workload identity pool.\n\n* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique\n   identifier) representing a user that has been recently deleted. For\n   example, `alice@example.com?uid=123456789012345678901`. If the user is\n   recovered, this value reverts to `user:{emailid}` and the recovered user\n   retains the role in the binding.\n\n* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus\n   unique identifier) representing a service account that has been recently\n   deleted. For example,\n   `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.\n   If the service account is undeleted, this value reverts to\n   `serviceAccount:{emailid}` and the undeleted service account retains the\n   role in the binding.\n\n* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique\n   identifier) representing a Google group that has been recently\n   deleted. For example, `admins@example.com?uid=123456789012345678901`. If\n   the group is recovered, this value reverts to `group:{emailid}` and the\n   recovered group retains the role in the binding.\n\n* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`:\n  Deleted single identity in a workforce identity pool. For example,\n  `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\n\nFor an overview of the IAM roles and permissions, see the\n[IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For\na list of the available pre-defined roles, see\n[here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
"type": "object"
},
"BulkInsertDiskResource": {
"description": "A transient resource used in compute.disks.bulkInsert and\ncompute.regionDisks.bulkInsert. It is only used to process\nrequests and is not persisted.",
"id": "BulkInsertDiskResource",
"properties": {
"instantSnapshotGroupParameters": {
"$ref": "InstantSnapshotGroupParameters",
"description": "The parameters for the instant snapshot group."
},
"snapshotGroupParameters": {
"$ref": "SnapshotGroupParameters",
"description": "The parameters for the snapshot group. The usage of snapshot group feature\nis restricted."
},
"sourceConsistencyGroupPolicy": {
"description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to clone.\nThis may be a full or partial URL, such as:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n     \n     - \n       projects/project/regions/region/resourcePolicies/resourcePolicy\n     \n     - \n       regions/region/resourcePolicies/resourcePolicy",
"type": "string"
}
},
"type": "object"
},
"BulkInsertInstanceResource": {
"description": "A transient resource used in compute.instances.bulkInsert and\ncompute.regionInstances.bulkInsert . This resource is not persisted\nanywhere, it is used only for processing the requests.",
"id": "BulkInsertInstanceResource",
"properties": {
"count": {
"description": "The maximum number of instances to create.",
"format": "int64",
"type": "string"
},
"instanceFlexibilityPolicy": {
"$ref": "InstanceFlexibilityPolicy",
"description": "A flexible specification of machine type of instances to create."
},
"instanceProperties": {
"$ref": "InstanceProperties",
"description": "The instance properties defining the VM instances to be created. Required\nif sourceInstanceTemplate is not provided."
},
"locationPolicy": {
"$ref": "LocationPolicy",
"description": "Policy for choosing target zone. For more information, seeCreate VMs in\nbulk."
},
"minCount": {
"description": "The minimum number of instances to create. If no min_count is\nspecified then count is used as the default value. Ifmin_count instances cannot be created, then no instances will\nbe created and instances already created will be deleted.",
"format": "int64",
"type": "string"
},
"namePattern": {
"description": "The string pattern used for the names of the VMs.\nEither name_pattern or per_instance_properties\nmust be set. The pattern must contain one continuous sequence of\nplaceholder hash characters (#) with each character corresponding to one\ndigit of the generated instance name. Example: a name_pattern\nof inst-#### generates instance names such asinst-0001 and inst-0002. If existing instances\nin the same project and zone have names that match the name pattern\nthen the generated instance numbers start after the biggest\nexisting number. For example, if there exists an instance with nameinst-0050, then instance names generated using the patterninst-#### begin with inst-0051. The name pattern\nplaceholder #...# can contain up to 18 characters.",
"type": "string"
},
"perInstanceProperties": {
"additionalProperties": {
"$ref": "BulkInsertInstanceResourcePerInstanceProperties"
},
"description": "Per-instance properties to be set on individual instances.\nKeys of this map specify requested instance names.\nCan be empty if name_pattern is used.",
"type": "object"
},
"sourceInstanceTemplate": {
"description": "Specifies the instance template from which to create instances. You may\ncombine sourceInstanceTemplate withinstanceProperties to override specific values from an\nexisting instance template. Bulk API follows the semantics of JSON Merge\nPatch described by RFC\n7396.\n\nIt can be a full or partial URL. For example, the following are\nall valid URLs to an instance template: \n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate\n      - projects/project/global/instanceTemplates/instanceTemplate\n      - global/instanceTemplates/instanceTemplate\n\n\n\nThis field is optional.",
"type": "string"
}
},
"type": "object"
},
"BulkInsertInstanceResourcePerInstanceProperties": {
"description": "Per-instance properties to be set on individual instances.\nTo be extended in the future.",
"id": "BulkInsertInstanceResourcePerInstanceProperties",
"properties": {
"hostname": {
"description": "Specifies the hostname of the instance. More details in:\nhttps://cloud.google.com/compute/docs/instances/custom-hostname-vm#naming_convention",
"type": "string"
},
"name": {
"description": "Output only. This field is only temporary. It will be removed. Do not use it.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"BulkInsertOperationStatus": {
"id": "BulkInsertOperationStatus",
"properties": {
"createdVmCount": {
"description": "[Output Only] Count of VMs successfully created so far.",
"format": "int32",
"type": "integer"
},
"deletedVmCount": {
"description": "[Output Only] Count of VMs that got deleted during rollback.",
"format": "int32",
"type": "integer"
},
"failedToCreateVmCount": {
"description": "[Output Only] Count of VMs that started creating but encountered an\nerror.",
"format": "int32",
"type": "integer"
},
"status": {
"description": "[Output Only] Creation status of BulkInsert operation - information\nif the flow is rolling forward or rolling back.",
"enum": [
"CREATING",
"DONE",
"ROLLING_BACK",
"STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"Rolling forward - creating VMs.",
"Done",
"Rolling back - cleaning up after an error.",
""
],
"type": "string"
},
"targetVmCount": {
"description": "[Output Only] Count of VMs originally planned to be created.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"BulkSetLabelsRequest": {
"id": "BulkSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You may\noptionally provide an up-to-date fingerprint hash in order to update or\nchange labels. Make a get() request to the resource to get the\nlatest fingerprint.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels to set for this resource.",
"type": "object"
}
},
"type": "object"
},
"BulkZoneSetLabelsRequest": {
"id": "BulkZoneSetLabelsRequest",
"properties": {
"requests": {
"items": {
"$ref": "BulkSetLabelsRequest"
},
"type": "array"
}
},
"type": "object"
},
"BundledLocalSsds": {
"id": "BundledLocalSsds",
"properties": {
"defaultInterface": {
"description": "The default disk interface if the interface is not specified.",
"type": "string"
},
"partitionCount": {
"description": "The number of partitions.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CacheInvalidationRule": {
"id": "CacheInvalidationRule",
"properties": {
"cacheTags": {
"description": "A list of cache tags used to identify cached objects.\n\n   \n   - Cache tags are specified when the response is first cached, by setting\n   the `Cache-Tag` response header at the origin.\n   - Multiple cache tags in the same invalidation request are treated as\n   Boolean `OR` - for example, `tag1 OR tag2 OR tag3`.\n   - If other fields are also specified, these are treated as Boolean `AND`\n   with any tags.\n\n\nUp to 10 tags can be specified in a single invalidation request.",
"items": {
"type": "string"
},
"type": "array"
},
"host": {
"description": "If set, this invalidation rule will only apply to requests with a Host\nheader 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\nCDN.",
"id": "CacheKeyPolicy",
"properties": {
"includeHost": {
"description": "If true, requests to different hosts will be cached separately.",
"type": "boolean"
},
"includeHttpHeaders": {
"description": "Allows HTTP request headers (by name) to be used in the cache key.",
"items": {
"type": "string"
},
"type": "array"
},
"includeNamedCookies": {
"description": "Allows HTTP cookies (by name) to be used in the cache key.\nThe name=value pair will be used in the cache key Cloud CDN generates.",
"items": {
"type": "string"
},
"type": "array"
},
"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\nquery_string_whitelist and query_string_blacklist. If neither is set, the\nentire query string will be included. If false, the query string will be\nexcluded from the cache key entirely.",
"type": "boolean"
},
"queryStringBlacklist": {
"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify query_string_whitelist or\nquery_string_blacklist, not both. '&' and '=' will be percent encoded and\nnot treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
},
"queryStringWhitelist": {
"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify query_string_whitelist or\nquery_string_blacklist, not both. '&' and '=' will be percent encoded and\nnot treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CachePolicy": {
"description": "Message containing CachePolicy configuration for URL Map's Route Action.",
"id": "CachePolicy",
"properties": {
"cacheBypassRequestHeaderNames": {
"description": "Bypass the cache when the specified request headers are matched by name,\ne.g. Pragma or Authorization headers. Values are case-insensitive. Up to 5\nheader names can be specified. The cache is bypassed for all `cacheMode`\nvalues.",
"items": {
"type": "string"
},
"type": "array"
},
"cacheKeyPolicy": {
"$ref": "CachePolicyCacheKeyPolicy",
"description": "The cache key configuration. If not specified, the default behavior depends\non the backend type: for Backend Services, the complete request URI is\nused; for Backend Buckets, the request URI is used without the protocol or\nhost, and only query parameters known to Cloud Storage are included."
},
"cacheMode": {
"description": "Specifies the cache setting for all responses from this route. If not\nspecified, Cloud CDN uses `CACHE_ALL_STATIC` mode.",
"enum": [
"CACHE_ALL_STATIC",
"FORCE_CACHE_ALL",
"USE_ORIGIN_HEADERS"
],
"enumDescriptions": [
"Automatically cache static content, including common image formats,\nmedia (video and audio), and web assets (JavaScript and CSS).\nRequests and responses that are marked as uncacheable, as well as\ndynamic content (including HTML), will not be cached.",
"Cache all content, ignoring any \"private\", \"no-store\" or \"no-cache\"\ndirectives in Cache-Control response headers.\nWarning: this may result in Cloud CDN caching private,\nper-user (user identifiable) content.",
"Requires the origin to set valid caching headers to cache content.\nResponses without these headers will not be cached at the edge, and will\nrequire a full trip to the origin on every request, potentially impacting\nperformance and increasing load on the origin server."
],
"type": "string"
},
"clientTtl": {
"$ref": "Duration",
"description": "Specifies a separate client (e.g. browser client) maximum TTL for cached\ncontent. This is used to clamp the max-age (or Expires) value sent to the\nclient. With `FORCE_CACHE_ALL`, the lesser of `clientTtl` and `defaultTtl`\nis used for the response max-age directive, along with a \"public\"\ndirective. For cacheable content in `CACHE_ALL_STATIC` mode, `clientTtl`\nclamps the max-age from the origin (if specified), or else sets the\nresponse max-age directive to the lesser of the `clientTtl` and\n`defaultTtl`, and also ensures a \"public\" cache-control directive is\npresent. The maximum allowed value is 31,622,400s (1 year). If not\nspecified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` mode.\nCannot exceed `maxTtl`. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`."
},
"defaultTtl": {
"$ref": "Duration",
"description": "Specifies the default TTL for cached content for responses that do not have\nan existing valid TTL (max-age or s-maxage). Setting a TTL of \"0\" means\n\"always revalidate\". The value of `defaultTtl` cannot be set to a value\ngreater than that of `maxTtl`. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, the `defaultTtl` will overwrite the TTL set in all\nresponses. The maximum allowed value is 31,622,400s (1 year). Infrequently\naccessed objects may be evicted from the cache before the defined TTL. If\nnot specified, Cloud CDN uses 3600s (1 hour) for `CACHE_ALL_STATIC` and\n`FORCE_CACHE_ALL` modes. Cannot be specified when `cacheMode` is\n`USE_ORIGIN_HEADERS`."
},
"maxTtl": {
"$ref": "Duration",
"description": "Specifies the maximum allowed TTL for cached content. Cache directives that\nattempt to set a max-age or s-maxage higher than this, or an Expires header\nmore than `maxTtl` seconds in the future will be capped at the value of\n`maxTtl`, as if it were the value of an s-maxage Cache-Control directive.\nHeaders sent to the client will not be modified. Setting a TTL of \"0\" means\n\"always revalidate\". The maximum allowed value is 31,622,400s (1 year).\nInfrequently accessed objects may be evicted from the cache before the\ndefined TTL. If not specified, Cloud CDN uses 86400s (1 day) for\n`CACHE_ALL_STATIC` mode. Can be specified only for `CACHE_ALL_STATIC` cache\nmode."
},
"negativeCaching": {
"description": "Negative caching allows per-status code TTLs to be set, in order\nto apply fine-grained caching for common errors or redirects.\nThis can reduce the load on your origin and improve end-user\nexperience by reducing response latency.\nWhen the `cacheMode` is set to `CACHE_ALL_STATIC` or\n`USE_ORIGIN_HEADERS`, negative caching applies to responses with\nthe specified response code that lack any Cache-Control, Expires, or\nPragma: no-cache directives. When the `cacheMode` is set to\n`FORCE_CACHE_ALL`, negative caching applies to all responses\nwith the specified response code, and overrides any caching headers. By\ndefault, Cloud CDN applies the following TTLs to these HTTP status codes:\n\n* 300 (Multiple Choice), 301, 308 (Permanent Redirects): 10m\n* 404 (Not Found), 410 (Gone), 451 (Unavailable For Legal Reasons): 120s\n* 405 (Method Not Found), 501 (Not Implemented): 60s\n\nThese defaults can be overridden in `negativeCachingPolicy`.\nIf not specified, Cloud CDN applies negative caching by default.",
"type": "boolean"
},
"negativeCachingPolicy": {
"description": "Sets a cache TTL for the specified HTTP status code.\n`negativeCaching` must be enabled to configure `negativeCachingPolicy`.\nOmitting the policy and leaving `negativeCaching` enabled will use Cloud\nCDN's default cache TTLs. Note that when specifying an explicit\n`negativeCachingPolicy`, you should take care to specify a cache TTL for\nall response codes that you wish to cache. Cloud CDN will not apply any\ndefault negative caching when a policy exists.",
"items": {
"$ref": "CachePolicyNegativeCachingPolicy"
},
"type": "array"
},
"requestCoalescing": {
"description": "If true then Cloud CDN will combine multiple concurrent cache fill\nrequests into a small number of requests to the origin. If not specified,\nCloud CDN applies request coalescing by default.",
"type": "boolean"
},
"serveWhileStale": {
"$ref": "Duration",
"description": "Serve existing content from the cache (if available) when revalidating\ncontent with the origin, or when an error is encountered when refreshing\nthe cache.\nThis setting defines the default \"max-stale\" duration for any cached\nresponses that do not specify a max-stale directive. Stale responses that\nexceed the TTL configured here will not be served. The default limit\n(max-stale) is 86400s (1 day), which will allow stale content to be\nserved up to this limit beyond the max-age (or s-maxage) of a cached\nresponse.\nThe maximum allowed value is 604800 (1 week).\nSet this to zero (0) to disable serve-while-stale."
}
},
"type": "object"
},
"CachePolicyCacheKeyPolicy": {
"description": "Message containing what to include in the cache key for a request for Cache\nPolicy defined on Route Action.",
"id": "CachePolicyCacheKeyPolicy",
"properties": {
"excludedQueryParameters": {
"description": "Names of query string parameters to exclude in cache keys. All other\nparameters will be included. Either specify `excludedQueryParameters`\nor `includedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.",
"items": {
"type": "string"
},
"type": "array"
},
"includeHost": {
"description": "If true, requests to different hosts will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nhost is never included in a Backend Bucket's cache key. Attempting to set\nit on a route that points exclusively to Backend Buckets will result in a\nconfiguration error.",
"type": "boolean"
},
"includeProtocol": {
"description": "If true, http and https requests will be cached separately.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket, as the\nprotocol is never included in a Backend Bucket's cache key. Attempting to\nset on a route that points exclusively to Backend Buckets will result in\na configuration error.",
"type": "boolean"
},
"includeQueryString": {
"description": "If true, include query string parameters in the cache key according to\n`includedQueryParameters` and `excludedQueryParameters`. If neither\nis set, the entire query string will be included. If false, the query\nstring will be excluded from the cache key entirely.\n\nNote: This field applies to routes that use backend services. Attempting\nto set it on a route that points exclusively to Backend Buckets will\nresult in a configuration error. For routes that point to a Backend\nBucket, use `includedQueryParameters` to define which parameters should\nbe part of the cache key.",
"type": "boolean"
},
"includedCookieNames": {
"description": "Allows HTTP cookies (by name) to be used in the cache key.\nThe name=value pair will be used in the cache key Cloud CDN generates.\n\nNote: This setting is only applicable to routes that use a Backend\nService. It does not affect requests served by a Backend Bucket.\nAttempting to set it on a route that points exclusively to Backend\nBuckets will result in a configuration error. Up to 5 cookie names can be\nspecified.",
"items": {
"type": "string"
},
"type": "array"
},
"includedHeaderNames": {
"description": "Allows HTTP request headers (by name) to be used in the cache key.",
"items": {
"type": "string"
},
"type": "array"
},
"includedQueryParameters": {
"description": "Names of query string parameters to include in cache keys. All other\nparameters will be excluded. Either specify `includedQueryParameters`\nor `excludedQueryParameters`, not both. '&' and '=' will be percent\nencoded and not treated as delimiters.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"CachePolicyNegativeCachingPolicy": {
"description": "Specify CDN TTLs for response error codes.",
"id": "CachePolicyNegativeCachingPolicy",
"properties": {
"code": {
"description": "The HTTP status code to define a TTL against. Only HTTP status codes\n300, 301, 302, 307, 308, 404, 405, 410, 421, 451 and 501 can be\nspecified as values, and you cannot specify a status code more than\nonce.",
"format": "int32",
"type": "integer"
},
"ttl": {
"$ref": "Duration",
"description": "The TTL (in seconds) for which to cache responses with the\ncorresponding status code.\nThe maximum allowed value is 1800s (30 minutes). Infrequently accessed\nobjects may be evicted from the cache before the defined TTL."
}
},
"type": "object"
},
"CalendarModeAdviceRequest": {
"description": "A request to recommend the best way to consume the specified resources in the\nfuture.",
"id": "CalendarModeAdviceRequest",
"properties": {
"futureResourcesSpecs": {
"additionalProperties": {
"$ref": "FutureResourcesSpec"
},
"description": "Specification of resources to create in the future.\nThe key of the map is an arbitrary string specified by the caller.\nValue of the map is a specification of required resources and their\nconstraints. Currently only one value is allowed in this map.",
"type": "object"
}
},
"type": "object"
},
"CalendarModeAdviceResponse": {
"description": "A response containing the recommended way of creating the specified resources\nin the future. It contains (will contain) multiple recommendations that can\nbe analyzed by the customer and the best one can be picked.",
"id": "CalendarModeAdviceResponse",
"properties": {
"recommendations": {
"description": "Recommendations where, how and when to create the requested resources\nin order to maximize their obtainability and minimize cost.",
"items": {
"$ref": "CalendarModeRecommendation"
},
"type": "array"
}
},
"type": "object"
},
"CalendarModeRecommendation": {
"description": "A single recommendation to create requested resources. Contains detailed\nrecommendations for every future resources specification specified in\nCalendarModeAdviceRequest.",
"id": "CalendarModeRecommendation",
"properties": {
"recommendationsPerSpec": {
"additionalProperties": {
"$ref": "FutureResourcesRecommendation"
},
"description": "Recommendations for every future resource specification passed in\nCalendarModeAdviceRequest. Keys of the map correspond to keys\nspecified in the request.",
"type": "object"
}
},
"type": "object"
},
"CircuitBreakers": {
"description": "Settings controlling the volume of requests, connections and retries to this\nbackend service.",
"id": "CircuitBreakers",
"properties": {
"maxConnections": {
"description": "The maximum number of connections to the backend service. If not specified,\nthere is no limit.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.",
"format": "int32",
"type": "integer"
},
"maxPendingRequests": {
"description": "The maximum number of pending requests allowed to the backend service. If\nnot specified, there is no limit.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.",
"format": "int32",
"type": "integer"
},
"maxRequests": {
"description": "The maximum number of parallel requests that allowed to the backend\nservice. If not specified, there is no limit.",
"format": "int32",
"type": "integer"
},
"maxRequestsPerConnection": {
"description": "Maximum requests for a single connection to the backend service.\nThis parameter is respected by both the HTTP/1.1 and HTTP/2\nimplementations. If not specified, there is no limit. Setting this\nparameter to 1 will effectively disable keep alive.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.",
"format": "int32",
"type": "integer"
},
"maxRetries": {
"description": "The maximum number of parallel retries allowed to the backend cluster. If\nnot specified, the default is 1.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Commitment": {
"description": "Represents a regional resource-based commitment resource.\n\nCreating this commitment resource means that you are purchasing a\nresource-based committed use contract, with an explicit start and end time.\nYou can purchase resource-based commitments for both hardware and software\nresources. For more information, read\nResource-based committed use discounts",
"id": "Commitment",
"properties": {
"autoRenew": {
"description": "Specifies whether to automatically renew the commitment at the end of its\ncurrent term. The default value is false. If you set the field\nto true, each time your commitment reaches the end of its\nterm, Compute Engine automatically renews it for another term. You can\nupdate this field anytime before the commitment expires. For example, if\nthe commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can\nupdate this field until 11:59 PM UTC-8 on January 2, 2027.",
"type": "boolean"
},
"category": {
"description": "The category of the commitment; specifies whether the commitment is for\nhardware or software resources. Category MACHINE specifies\nthat you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources.\nCategory LICENSE specifies that you are committing to software\nlicenses, listed in licenseResources.\nNote that if you specify MACHINE commitments, then you must\nalso specify a type to indicate the machine series of the\nhardware resource that you are committing to.",
"enum": [
"CATEGORY_UNSPECIFIED",
"LICENSE",
"MACHINE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"customEndTimestamp": {
"description": "[Input Only] Optional, specifies the requested commitment end time inRFC3339 text format. Use this option when the desired\ncommitment's end date is later than the start date + term duration.",
"type": "string"
},
"description": {
"description": "An optional description of the commitment. You can provide this property\nwhen you create the resource.",
"type": "string"
},
"endTimestamp": {
"description": "Output only. [Output Only] Commitment end time inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"existingReservations": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#commitment",
"description": "Output only. [Output Only] Type of the resource. Always compute#commitment\nfor commitments.",
"readOnly": true,
"type": "string"
},
"licenseResource": {
"$ref": "LicenseResourceCommitment",
"description": "The license specification required as part of a license commitment."
},
"mergeSourceCommitments": {
"description": "The list of source commitments that you are merging to create the new\nmerged commitment. For more information, see\nMerging commitments.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "Name of the commitment. You must specify a name when you purchase the\ncommitment. The name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "CommitmentParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"plan": {
"description": "The minimum time duration that you commit to purchasing resources.\nThe plan that you choose determines the preset term length of the\ncommitment (which is 1 year or 3 years) and affects the discount rate that\nyou receive for your resources. Committing to a longer time duration\ntypically gives you a higher discount rate. The supported values for this\nfield are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).",
"enum": [
"INVALID",
"THIRTY_SIX_MONTH",
"TWELVE_MONTH"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the commitment and committed\nresources are located.",
"readOnly": true,
"type": "string"
},
"reservations": {
"description": "The list of new reservations that you want to create and attach to this\ncommitment.\n\nYou must attach reservations to your commitment if your commitment\nspecifies any GPUs or Local SSD disks. For more information, see \nAttach reservations to resource-based commitments.\n\nSpecify this property only if you want to create new\nreservations to attach. To attach existing reservations, specify theexistingReservations property instead.",
"items": {
"$ref": "Reservation"
},
"type": "array"
},
"resourceStatus": {
"$ref": "CommitmentResourceStatus",
"description": "Output only. [Output Only] Status information for Commitment resource.",
"readOnly": true
},
"resources": {
"description": "The list of all the hardware resources, with their types and amounts, that\nyou want to commit to. Specify as a separate entry in the list for each\nindividual resource type.",
"items": {
"$ref": "ResourceCommitment"
},
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"splitSourceCommitment": {
"description": "The source commitment from which you are transferring resources to create\nthe new split commitment. For more information, see \nSplit commitments.",
"type": "string"
},
"startTimestamp": {
"description": "Output only. [Output Only] Commitment start time inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] Status of the commitment with regards to eventual expiration\n(each commitment has an end date defined). Status can be one of the\nfollowing values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.",
"enum": [
"ACTIVE",
"CANCELLED",
"CREATING",
"EXPIRED",
"NOT_YET_ACTIVE"
],
"enumDescriptions": [
"",
"Deprecate CANCELED status. Will use separate status to differentiate\ncancel by mergeCud or manual cancellation.",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. [Output Only] An optional, human-readable explanation of the status.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "The type of commitment; specifies the\nmachine series for which you want to commit to purchasing resources.\nThe choice of machine series affects the discount rate and the eligible\nresource types.\n\n The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D,\n COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For\nexample, type MEMORY_OPTIMIZED specifies a commitment that\napplies only to eligible resources of memory optimized M1 and M2 machine\nseries. Type GENERAL_PURPOSE specifies a commitment that\napplies only to eligible resources of general purpose N1 machine series.",
"enum": [
"ACCELERATOR_OPTIMIZED",
"ACCELERATOR_OPTIMIZED_A3",
"ACCELERATOR_OPTIMIZED_A3_MEGA",
"ACCELERATOR_OPTIMIZED_A3_ULTRA",
"ACCELERATOR_OPTIMIZED_A4",
"COMPUTE_OPTIMIZED",
"COMPUTE_OPTIMIZED_C2D",
"COMPUTE_OPTIMIZED_C3",
"COMPUTE_OPTIMIZED_C3D",
"COMPUTE_OPTIMIZED_H3",
"COMPUTE_OPTIMIZED_H4D",
"GENERAL_PURPOSE",
"GENERAL_PURPOSE_C4",
"GENERAL_PURPOSE_C4A",
"GENERAL_PURPOSE_C4D",
"GENERAL_PURPOSE_E2",
"GENERAL_PURPOSE_N2",
"GENERAL_PURPOSE_N2D",
"GENERAL_PURPOSE_N4",
"GENERAL_PURPOSE_N4A",
"GENERAL_PURPOSE_N4D",
"GENERAL_PURPOSE_T2D",
"GRAPHICS_OPTIMIZED",
"GRAPHICS_OPTIMIZED_G4",
"GRAPHICS_OPTIMIZED_G4_VGPU",
"MEMORY_OPTIMIZED",
"MEMORY_OPTIMIZED_M3",
"MEMORY_OPTIMIZED_M4",
"MEMORY_OPTIMIZED_M4_6TB",
"MEMORY_OPTIMIZED_X4_1440_24T",
"MEMORY_OPTIMIZED_X4_16TB",
"MEMORY_OPTIMIZED_X4_1920_32T",
"MEMORY_OPTIMIZED_X4_24TB",
"MEMORY_OPTIMIZED_X4_32TB",
"MEMORY_OPTIMIZED_X4_480_6T",
"MEMORY_OPTIMIZED_X4_480_8T",
"MEMORY_OPTIMIZED_X4_960_12T",
"MEMORY_OPTIMIZED_X4_960_16T",
"STORAGE_OPTIMIZED_Z3",
"TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"CUD bucket for X4 machine with 1440 vCPUs and 24TB of memory.",
"",
"CUD bucket for X4 machine with 1920 vCPUs and 32TB of memory.",
"",
"",
"CUD bucket for X4 machine with 480 vCPUs and 6TB of memory.",
"CUD bucket for X4 machine with 480 vCPUs and 8TB of memory.",
"CUD bucket for X4 machine with 960 vCPUs and 12TB of memory.",
"CUD bucket for X4 machine with 960 vCPUs and 16TB of memory.",
"",
"Note for internal users: When adding a new enum Type for v1, make sure\nto also add it in the comment for the `optional Type type` definition.\nThis ensures that the public documentation displays the new enum Type."
],
"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. [Output Only] Type of resource. Alwayscompute#commitmentAggregatedList for aggregated lists of\ncommitments.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#commitmentList\nfor lists of commitments.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"CommitmentParams": {
"description": "Additional commitment params.",
"id": "CommitmentParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the commitment. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"CommitmentResourceStatus": {
"description": "[Output Only] Contains output only fields.",
"id": "CommitmentResourceStatus",
"properties": {
"customTermEligibilityEndTimestamp": {
"description": "Output only. [Output Only] Indicates the end time of customer's eligibility to send\ncustom term requests in RFC3339 text format. Term extension requests that\n(not the end time in the request) after this time will be rejected.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CommitmentsScopedList": {
"id": "CommitmentsScopedList",
"properties": {
"commitments": {
"description": "[Output Only] The list of commitments contained in this scope.",
"items": {
"$ref": "Commitment"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of commitments\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"CompositeHealthCheck": {
"description": "Represents a composite health check.\n\nA composite health check resource specifies the health source resources and\nthe health destination resource to which the aggregated health result from\nthe health source resources is delivered.",
"id": "CompositeHealthCheck",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a CompositeHealthCheck. An up-to-date fingerprint\nmust be provided in order to patch the CompositeHealthCheck; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nCompositeHealthCheck.",
"format": "byte",
"type": "string"
},
"healthDestination": {
"description": "URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have\nload balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region\nas the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated.",
"type": "string"
},
"healthSources": {
"description": "URLs to the HealthSource resources whose results are AND'ed.\nI.e. he aggregated result is is HEALTHY only if all sources\nare HEALTHY. Must have at least 1. Must not have more than 10.\nMust be regional and in the same region as theCompositeHealthCheck. Can be mutated.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#compositeHealthCheck",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the composite health check resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL with id for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CompositeHealthCheckAggregatedList": {
"description": "Contains a list of CompositeHealthChecksScopedList.",
"id": "CompositeHealthCheckAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "CompositeHealthChecksScopedList",
"description": "Name of the scope containing this set of CompositeHealthChecks."
},
"description": "A list of CompositeHealthChecksScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#compositeHealthCheckAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"CompositeHealthCheckHealth": {
"description": "Response message for RegionCompositeHealthChecks.GetHealth",
"id": "CompositeHealthCheckHealth",
"properties": {
"healthSources": {
"description": "Health sources and their corresponding health states.",
"items": {
"$ref": "CompositeHealthChecksGetHealthResponseHealthSourceHealth"
},
"type": "array"
},
"healthState": {
"description": "Health state of the CompositeHealthCheck.",
"enum": [
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#compositeHealthCheckHealth",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#compositeHealthCheckHealth for the health of\ncomposite health checks.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CompositeHealthCheckList": {
"id": "CompositeHealthCheckList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of CompositeHealthCheck resources.",
"items": {
"$ref": "CompositeHealthCheck"
},
"type": "array"
},
"kind": {
"default": "compute#compositeHealthCheckList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#compositeHealthCheck for composite health checks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"CompositeHealthChecksGetHealthResponseHealthSourceHealth": {
"id": "CompositeHealthChecksGetHealthResponseHealthSourceHealth",
"properties": {
"healthState": {
"description": "Health state of the associated HealthSource resource.",
"enum": [
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"source": {
"description": "Fully qualified URL of the associated HealthSource resource.",
"type": "string"
}
},
"type": "object"
},
"CompositeHealthChecksScopedList": {
"id": "CompositeHealthChecksScopedList",
"properties": {
"compositeHealthChecks": {
"description": "A list of CompositeHealthChecks contained in this scope.",
"items": {
"$ref": "CompositeHealthCheck"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of composite health checks\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ConfidentialInstanceConfig": {
"description": "A set of Confidential Instance options.",
"id": "ConfidentialInstanceConfig",
"properties": {
"confidentialInstanceType": {
"description": "Defines the type of technology used by the confidential instance.",
"enum": [
"CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED",
"SEV",
"SEV_SNP",
"TDX"
],
"enumDescriptions": [
"No type specified. Do not use this value.",
"AMD Secure Encrypted Virtualization.",
"AMD Secure Encrypted Virtualization - Secure Nested Paging.",
"Intel Trust Domain eXtension."
],
"type": "string"
},
"enableConfidentialCompute": {
"description": "Defines whether the instance should have confidential compute enabled.",
"type": "boolean"
}
},
"type": "object"
},
"ConnectionDraining": {
"description": "Message containing connection draining configuration.",
"id": "ConnectionDraining",
"properties": {
"drainingTimeoutSec": {
"description": "Configures a duration timeout for existing requests on a removed backend\ninstance. For supported load balancers and protocols, as described inEnabling\nconnection draining.",
"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\nbe used as the hash key for the consistent hash load balancer. If the\ncookie is not present, it will be generated. This field is applicable if\nthe sessionAffinity is set to HTTP_COOKIE.\n\nNot supported when the backend service is referenced by a URL map that is\nbound to target gRPC proxy that has validateForProxyless field set to true."
},
"httpHeaderName": {
"description": "The hash based on the value of the specified header field. This field is\napplicable if the sessionAffinity is set toHEADER_FIELD.",
"type": "string"
},
"minimumRingSize": {
"description": "The minimum number of virtual nodes to use for the hash ring. Defaults to\n1024. Larger ring sizes result in more granular load distributions. If the\nnumber of hosts in the load balancing pool is larger than the ring size,\neach 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\nfor 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. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.",
"id": "CorsPolicy",
"properties": {
"allowCredentials": {
"description": "In response to a preflight request, setting this to true\nindicates that\nthe actual request can include user credentials. This field translates to\nthe Access-Control-Allow-Credentials header.\n\nDefault is false.",
"type": "boolean"
},
"allowHeaders": {
"description": "Specifies the content for the Access-Control-Allow-Headers\nheader.",
"items": {
"type": "string"
},
"type": "array"
},
"allowMethods": {
"description": "Specifies the content for the Access-Control-Allow-Methods\nheader.",
"items": {
"type": "string"
},
"type": "array"
},
"allowOriginRegexes": {
"description": "Specifies a regular expression that matches allowed origins. For\nmore information, see regular expression syntax. \n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED.",
"items": {
"type": "string"
},
"type": "array"
},
"allowOrigins": {
"description": "Specifies the list of origins that is allowed to do CORS requests.\n\nAn origin is allowed if it matches either an item inallowOrigins or an item inallowOriginRegexes.",
"items": {
"type": "string"
},
"type": "array"
},
"disabled": {
"description": "If true, disables the CORS policy.\nThe default value is false, which indicates that the CORS\npolicy is in effect.",
"type": "boolean"
},
"exposeHeaders": {
"description": "Specifies the content for the Access-Control-Expose-Headers\nheader.",
"items": {
"type": "string"
},
"type": "array"
},
"maxAge": {
"description": "Specifies how long results of a preflight request can be cached in\nseconds. This field translates to the Access-Control-Max-Age\nheader.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"CrossSiteNetwork": {
"description": "A resource that represents a cross-site network.\n\nYou can use cross-site networks to connect your on-premises networks to\neach other through Interconnect connections.",
"id": "CrossSiteNetwork",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of the cross-site network.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#crossSiteNetwork",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"CrossSiteNetworkList": {
"description": "Response to the list request that contains a list of cross-site networks.",
"id": "CrossSiteNetworkList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of CrossSiteNetwork resources.",
"items": {
"$ref": "CrossSiteNetwork"
},
"type": "array"
},
"kind": {
"default": "compute#crossSiteNetwork",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#crossSiteNetwork for cross-site networks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"CustomErrorResponsePolicy": {
"description": "Specifies the custom error response policy that must be applied when the\nbackend service or backend bucket responds with an error.",
"id": "CustomErrorResponsePolicy",
"properties": {
"errorResponseRules": {
"description": "Specifies rules for returning error responses.\n\nIn a given policy, if you specify rules for both a range of error codes\nas well as rules for specific error codes then rules with specific error\ncodes have a higher priority. For example, assume that you configure a rule\nfor 401 (Un-authorized) code, and another for all 4 series\nerror codes (4XX). If the backend service returns a401, then the rule for 401 will be applied.\nHowever if the backend service returns a 403, the rule for4xx takes effect.",
"items": {
"$ref": "CustomErrorResponsePolicyCustomErrorResponseRule"
},
"type": "array"
},
"errorService": {
"description": "The full or partial URL to the BackendBucket resource that\ncontains the custom error content. Examples are:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket\n     - compute/v1/projects/project/global/backendBuckets/myBackendBucket\n     - global/backendBuckets/myBackendBucket\n\nIf errorService is not specified at lower levels likepathMatcher, pathRule and routeRule,\nan errorService specified at a higher level in theUrlMap will be used. IfUrlMap.defaultCustomErrorResponsePolicy contains one or moreerrorResponseRules[], it must specifyerrorService. \n\nIf load balancer cannot reach\nthe backendBucket, a simple Not Found Error will\nbe returned, with the original response code (oroverrideResponseCode if configured).\n\nerrorService is not supported for internal or regionalHTTP/HTTPS load balancers.",
"type": "string"
}
},
"type": "object"
},
"CustomErrorResponsePolicyCustomErrorResponseRule": {
"description": "Specifies the mapping between the response code that will be returned along\nwith the custom error content and the response code returned by the backend\nservice.",
"id": "CustomErrorResponsePolicyCustomErrorResponseRule",
"properties": {
"matchResponseCodes": {
"description": "Valid values include:\n   \n   \n     - A number between 400 and 599: For example\n     401 or 503, in which case the load balancer\n     applies the policy if the error code exactly matches this value.\n     - 5xx: Load Balancer will apply the policy if the\n     backend service responds with any response code in the range of\n     500 to 599. \n   - 4xx: Load\n     Balancer will apply the policy if the backend service responds with any\n     response code in the range of 400 to\n     499.\n\nValues must be unique within matchResponseCodes and across allerrorResponseRules ofCustomErrorResponsePolicy.",
"items": {
"type": "string"
},
"type": "array"
},
"overrideResponseCode": {
"description": "The HTTP status code returned with the response containing the custom\nerror content. If overrideResponseCode is not supplied, the\nsame response code returned by the original backend bucket or backend\nservice is returned to the client.",
"format": "int32",
"type": "integer"
},
"path": {
"description": "The full path to a file within backendBucket . For example:/errors/defaultError.html \n\npath must start\nwith a leading slash. path cannot have trailing slashes.\n\nIf the file is not available in backendBucket  or the\nload balancer cannot reach the BackendBucket, a simpleNot Found Error is returned to the client. \n\nThe value must\nbe from 1 to 1024 characters",
"type": "string"
}
},
"type": "object"
},
"CustomerEncryptionKey": {
"id": "CustomerEncryptionKey",
"properties": {
"kmsKeyName": {
"description": "The name of the encryption key that is stored in Google Cloud KMS.\nFor example:\n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n\nThe fully-qualifed key name may be returned for resource GET requests. For \nexample: \n\n\"kmsKeyName\": \"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n/cryptoKeyVersions/1",
"type": "string"
},
"kmsKeyServiceAccount": {
"description": "The service account being used for the encryption request for the given KMS\nkey. If absent, the Compute Engine default service account is used.\nFor example:\n\n\"kmsKeyServiceAccount\": \"name@project_id.iam.gserviceaccount.com/",
"type": "string"
},
"rawKey": {
"description": "Specifies a 256-bit customer-supplied\nencryption key, encoded in RFC\n4648 base64 to either encrypt or decrypt this resource. You can\nprovide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rawKey\":\n\"SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0=\"",
"type": "string"
},
"rsaEncryptedKey": {
"description": "Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit\ncustomer-supplied encryption key to either encrypt or decrypt this\nresource. You can provide either the rawKey or thersaEncryptedKey.\nFor example:\n\n\"rsaEncryptedKey\":\n\"ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH\nz0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD\nD6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==\"\n\nThe key must meet the following requirements before you can provide it to \nCompute Engine: \n   \n   1. The key is wrapped using a RSA public key certificate provided by \n   Google. \n   2. After being wrapped, the key must be encoded in RFC 4648 base64 \n   encoding. \n\nGets the RSA public key certificate provided by Google at: \n\n\nhttps://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem",
"type": "string"
},
"sha256": {
"description": "[Output only] TheRFC\n4648 base64 encoded SHA-256 hash of the customer-supplied\nencryption key that protects this resource.",
"type": "string"
}
},
"type": "object"
},
"CustomerEncryptionKeyProtectedDisk": {
"id": "CustomerEncryptionKeyProtectedDisk",
"properties": {
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Decrypts data associated with the disk with acustomer-supplied\nencryption key."
},
"source": {
"description": "Specifies a valid partial or full URL to an existing Persistent Disk\nresource. This field is only applicable for persistent disks.\nFor example:\n\n\"source\": \"/compute/v1/projects/project_id/zones/zone/disks/\ndisk_name",
"type": "string"
}
},
"type": "object"
},
"Date": {
"description": "Represents a whole or partial calendar date, such as a birthday. The time of\nday and time zone are either specified elsewhere or are insignificant. The\ndate is relative to the Gregorian Calendar. This can represent one of the\nfollowing:\n\n* A full date, with non-zero year, month, and day values.\n* A month and day, with a zero year (for example, an anniversary).\n* A year on its own, with a zero month and a zero day.\n* A year and month, with a zero day (for example, a credit card expiration\n  date).\n\nRelated types:\n\n* google.type.TimeOfDay\n* google.type.DateTime\n* google.protobuf.Timestamp",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0\nto specify a year by itself or a year and month where the day isn't\nsignificant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a\nmonth and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without\na year.",
"format": "int32",
"type": "integer"
}
},
"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\nresource is intended to change to DELETED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.",
"type": "string"
},
"deprecated": {
"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to DEPRECATED. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.",
"type": "string"
},
"obsolete": {
"description": "An optional RFC3339 timestamp on or after which the state of this\nresource is intended to change to OBSOLETE. This is only\ninformational and the status will not change unless the client explicitly\nchanges it.",
"type": "string"
},
"replacement": {
"description": "The URL of the suggested replacement for a deprecated resource.\nThe suggested replacement resource must be the same kind of resource as the\ndeprecated resource.",
"type": "string"
},
"state": {
"description": "The deprecation state of this resource. This can be ACTIVE,DEPRECATED, OBSOLETE, or DELETED.\nOperations which communicate the end of life date for an image, can useACTIVE. Operations which create a new resource using aDEPRECATED resource will return successfully, but with a\nwarning indicating the deprecated resource and recommending its\nreplacement. Operations which use OBSOLETE orDELETED 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/v1/disks)\n* [Regional](/compute/docs/reference/rest/v1/regionDisks)\n\nPersistent disks are required for running your VM instances.\nCreate both boot and non-boot (data) persistent disks. For more information,\nread Persistent Disks. For more\nstorage options, read Storage options.\n\nThe disks resource represents a zonal persistent disk.\nFor more information, readZonal persistent disks.\n\nThe regionDisks resource represents a\nregional persistent disk.  For more information, read\nRegional resources.",
"id": "Disk",
"properties": {
"accessMode": {
"description": "The access mode of the disk.\n   \n   \n     - READ_WRITE_SINGLE: The default AccessMode, means the\n     disk can be attached to single instance in RW mode.\n     - READ_WRITE_MANY: The AccessMode means the disk can be\n     attached to multiple instances in RW mode.\n     - READ_ONLY_MANY: The AccessMode means the disk can be\n     attached to multiple instances in RO mode.\n\n\nThe AccessMode is only valid for Hyperdisk disk types.",
"enum": [
"READ_ONLY_MANY",
"READ_WRITE_MANY",
"READ_WRITE_SINGLE"
],
"enumDescriptions": [
"The AccessMode means the disk can be attached to multiple instances in RO\nmode.",
"The AccessMode means the disk can be attached to multiple instances in RW\nmode.",
"The default AccessMode, means the disk can be attached to single instance\nin RW mode."
],
"type": "string"
},
"architecture": {
"description": "The architecture of the disk. Valid values are\nARM64 or X86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"type": "string"
},
"asyncPrimaryDisk": {
"$ref": "DiskAsyncReplication",
"description": "Disk asynchronously replicated into this disk."
},
"asyncSecondaryDisks": {
"additionalProperties": {
"$ref": "DiskAsyncReplicationList"
},
"description": "Output only. [Output Only] A list of disks this disk is asynchronously replicated to.",
"readOnly": true,
"type": "object"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the disk using a\ncustomer-supplied encryption key or a \ncustomer-managed encryption key.\n\nEncryption keys do not protect access to metadata of the disk.\n\nAfter you encrypt a disk with a customer-supplied key, you must provide the\nsame key if you use the disk later. For example, to create a disk snapshot,\nto create a disk image, to create a machine image, or to attach the disk to\na virtual machine.\n\nAfter you encrypt a disk with a customer-managed key, thediskEncryptionKey.kmsKeyName is set to a key *version*\nname once the disk is created. The disk is encrypted with this version of\nthe key. In the response, diskEncryptionKey.kmsKeyName appears\nin the following format:\n\n\"diskEncryptionKey.kmsKeyName\":\n\"projects/kms_project_id/locations/region/keyRings/\nkey_region/cryptoKeys/key\n/cryptoKeysVersions/version\n\nIf you do not provide an encryption key when creating the disk, then the \ndisk is encrypted using an automatically generated key and you don't need \nto provide a key to use the disk later."
},
"enableConfidentialCompute": {
"description": "Whether this disk is using confidential compute mode.",
"type": "boolean"
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable\nonly for bootable images. Read\nEnabling guest operating system features to see a list of available\noptions.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#disk",
"description": "Output only. [Output Only] Type of the resource. Always compute#disk for\ndisks.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this disk, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a disk.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this disk. These can be later modified by\nthe setLabels method.",
"type": "object"
},
"lastAttachTimestamp": {
"description": "Output only. [Output Only] Last attach timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"lastDetachTimestamp": {
"description": "Output only. [Output Only] Last detach timestamp inRFC3339\ntext format.",
"readOnly": true,
"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"
},
"locationHint": {
"description": "An opaque location hint used to place the disk close to other resources.\nThis field is for use by internal tools that use the public API.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.disks.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe 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"
},
"params": {
"$ref": "DiskParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"physicalBlockSizeBytes": {
"description": "Physical block size of the persistent disk, in bytes.\nIf not present in a request, a default value is used.\nThe currently supported size is 4096, other sizes may be added in\nthe future.\nIf an unsupported value is requested, the error message will list\nthe supported values for the caller's project.",
"format": "int64",
"type": "string"
},
"provisionedIops": {
"description": "Indicates how many IOPS to provision for the disk. This sets the number\nof I/O operations per second that the disk can handle. Values must be\nbetween 10,000 and 120,000. For more details, see theExtreme persistent\ndisk documentation.",
"format": "int64",
"type": "string"
},
"provisionedThroughput": {
"description": "Indicates how much throughput to provision for the disk. This sets the\nnumber of throughput mb per second that the disk can handle. Values must be\ngreater than or equal to 1.",
"format": "int64",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the disk resides. Only applicable for\nregional resources.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"replicaZones": {
"description": "URLs of the zones where the disk should be replicated to. Only applicable\nfor regional resources.",
"items": {
"type": "string"
},
"type": "array"
},
"resourcePolicies": {
"description": "Resource policies applied to this disk for automatic snapshot creations.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceStatus": {
"$ref": "DiskResourceStatus",
"description": "Output only. [Output Only] Status information for the disk resource.",
"readOnly": true
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"sizeGb": {
"description": "Size, in GB, of the persistent disk. You can specify\nthis field when creating a persistent disk using thesourceImage, sourceSnapshot, orsourceDisk parameter, or specify it alone to create an empty\npersistent disk.\n\nIf you specify this field along with a source, the value ofsizeGb must not be less than the size of the\nsource.\nAcceptable values are greater than 0.",
"format": "int64",
"type": "string"
},
"sourceConsistencyGroupPolicy": {
"description": "Output only. [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk\nthat was created using a consistency group.",
"readOnly": true,
"type": "string"
},
"sourceConsistencyGroupPolicyId": {
"description": "Output only. [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk\nthat was created using a consistency group.",
"readOnly": true,
"type": "string"
},
"sourceDisk": {
"description": "The source disk used to create this disk. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk\n     \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk\n     \n     - \n       projects/project/zones/zone/disks/disk\n     \n     - \n       projects/project/regions/region/disks/disk\n     \n     - \n       zones/zone/disks/disk\n     \n     - \n       regions/region/disks/disk",
"type": "string"
},
"sourceDiskId": {
"description": "Output only. [Output Only] The unique ID of the disk used to create this disk. This\nvalue identifies the exact disk that was used to create this persistent\ndisk. For example, if you created the persistent disk from a disk that\nwas later deleted and recreated under the same name, the source disk ID\nwould identify the exact version of the disk that was used.",
"readOnly": true,
"type": "string"
},
"sourceImage": {
"description": "The source image used to create this disk. If the source image is\ndeleted, this field will not be set.\n\nTo create a disk with one of the public operating system images, specify\nthe image by its family name. For example, specifyfamily/debian-9 to use the latest Debian 9 image:\n\nprojects/debian-cloud/global/images/family/debian-9\n\n\nAlternatively, use a specific version of a public operating system image:\n\nprojects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD\n\n\nTo create a disk with a custom image that you created, specify the\nimage name in the following format:\n\nglobal/images/my-custom-image\n\n\nYou can also specify a custom image by its image family, which returns\nthe latest version of the image in that family. Replace the image name\nwith family/family-name:\n\nglobal/images/family/my-image-family",
"type": "string"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Thecustomer-supplied\nencryption key of the source image. Required if the source image is\nprotected by a customer-supplied encryption key."
},
"sourceImageId": {
"description": "Output only. [Output Only] The ID value of the image used to create this disk. This\nvalue identifies the exact image that was used to create this persistent\ndisk. For example, if you created the persistent disk from an image that\nwas later deleted and recreated under the same name, the source image ID\nwould identify the exact version of the image that was used.",
"readOnly": true,
"type": "string"
},
"sourceInstantSnapshot": {
"description": "The source instant snapshot used to create this disk. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot\n     - projects/project/zones/zone/instantSnapshots/instantSnapshot \n   - zones/zone/instantSnapshots/instantSnapshot",
"type": "string"
},
"sourceInstantSnapshotId": {
"description": "Output only. [Output Only] The unique ID of the instant snapshot used to create this\ndisk. This value identifies the exact instant snapshot that was used to\ncreate this persistent disk. For example, if you created the persistent\ndisk from an instant snapshot that was later deleted and recreated under\nthe same name, the source instant snapshot ID would identify the exact\nversion of the instant snapshot that was used.",
"readOnly": true,
"type": "string"
},
"sourceSnapshot": {
"description": "The source snapshot used to create this disk. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n   \n   \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": "Thecustomer-supplied\nencryption key of the source snapshot. Required if the source snapshot\nis protected by a customer-supplied encryption key."
},
"sourceSnapshotId": {
"description": "Output only. [Output Only] The unique ID of the snapshot used to create this disk. This\nvalue identifies the exact snapshot that was used to create this persistent\ndisk. For example, if you created the persistent disk from a snapshot that\nwas later deleted and recreated under the same name, the source snapshot ID\nwould identify the exact version of the snapshot that was used.",
"readOnly": true,
"type": "string"
},
"sourceStorageObject": {
"description": "The full Google Cloud Storage URI where the disk image is stored. This file\nmust be a gzip-compressed tarball whose name ends in .tar.gz or virtual\nmachine disk whose name ends in vmdk. Valid URIs may start with gs:// or\nhttps://storage.googleapis.com/. This flag is not optimized for creating\nmultiple disks from a source storage object. To create many disks from a\nsource storage object, use gcloud compute images\nimport instead.",
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of disk creation.\n   \n   \n     - CREATING: Disk is provisioning.\n     - RESTORING: Source data is being copied into the\n     disk.\n     - FAILED: Disk creation failed.\n     - READY: Disk is ready for use.\n     - DELETING: Disk is deleting.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"RESTORING",
"UNAVAILABLE"
],
"enumDescriptions": [
"Disk is provisioning",
"Disk is deleting.",
"Disk creation failed.",
"Disk is ready for use.",
"Source data is being copied into the disk.",
"Disk is currently unavailable and cannot be accessed, attached or\ndetached."
],
"readOnly": true,
"type": "string"
},
"storagePool": {
"description": "The storage pool in which the new disk is created. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/storagePools/storagePool\n     - projects/project/zones/zone/storagePools/storagePool \n   - zones/zone/storagePools/storagePool",
"type": "string"
},
"type": {
"description": "URL of the disk type resource describing which disk type to use to create\nthe disk. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.",
"type": "string"
},
"users": {
"description": "Output only. [Output Only] Links to the users of the disk (attached instances)\nin form:projects/project/zones/zone/instances/instance",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the disk resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"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. [Output Only] Type of resource. Alwayscompute#diskAggregatedList for aggregated lists of persistent\ndisks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"DiskAsyncReplication": {
"id": "DiskAsyncReplication",
"properties": {
"consistencyGroupPolicy": {
"description": "Output only. [Output Only] URL of the DiskConsistencyGroupPolicy if replication was\nstarted on the disk as a member of a group.",
"readOnly": true,
"type": "string"
},
"consistencyGroupPolicyId": {
"description": "Output only. [Output Only] ID of the DiskConsistencyGroupPolicy if replication was\nstarted on the disk as a member of a group.",
"readOnly": true,
"type": "string"
},
"disk": {
"description": "The other disk asynchronously replicated to or from the current disk.\nYou can provide this as a partial or full URL to the resource.\nFor example, the following are valid values:\n   \n   \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"
},
"diskId": {
"description": "Output only. [Output Only] The unique ID of the other disk asynchronously replicated\nto or from the current disk. This value identifies the exact disk that\nwas used to create this replication. For example, if you started\nreplicating the persistent disk from a disk that was later deleted and\nrecreated under the same name, the disk ID would identify the exact\nversion of the disk that was used.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"DiskAsyncReplicationList": {
"id": "DiskAsyncReplicationList",
"properties": {
"asyncReplicationDisk": {
"$ref": "DiskAsyncReplication"
}
},
"type": "object"
},
"DiskInstantiationConfig": {
"description": "A specification of the desired way to instantiate a disk in the instance\ntemplate when its created from a source instance.",
"id": "DiskInstantiationConfig",
"properties": {
"autoDelete": {
"description": "Specifies whether the disk will be auto-deleted when the instance is\ndeleted (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\nthis 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\nvalues are:\n   \n   \n     - source-image: to use the same image that was used to\n     create the source instance's corresponding disk. Applicable to the boot\n     disk and additional read-write disks.\n     - source-image-family: to use the same image family that\n     was used to create the source instance's corresponding disk. Applicable\n     to the boot disk and additional read-write disks.\n     - custom-image: to use a user-provided image url for disk\n     creation. Applicable to the boot disk and additional read-write\n     disks. \n   - attach-read-only: to attach a read-only\n     disk. Applicable to read-only disks.\n     - do-not-include: to exclude a disk from the template.\n     Applicable to additional read-write disks, local SSDs, and read-only\n     disks.",
"enum": [
"ATTACH_READ_ONLY",
"BLANK",
"CUSTOM_IMAGE",
"DEFAULT",
"DO_NOT_INCLUDE",
"SOURCE_IMAGE",
"SOURCE_IMAGE_FAMILY"
],
"enumDescriptions": [
"Attach the existing disk in read-only mode. The request will fail if the\ndisk was attached in read-write mode on the source instance. Applicable\nto: read-only disks.",
"Create a blank disk. The disk will be created unformatted. Applicable to:\nadditional read-write disks, local SSDs.",
"Use the custom image specified in the custom_image field. Applicable to:\nboot disk, additional read-write disks.",
"Use the default instantiation option for the corresponding type of disk.\nFor boot disk and any other R/W disks, new custom images will be created\nfrom each disk. For read-only disks, they will be attached in read-only\nmode. Local SSD disks will be created as blank volumes.",
"Do not include the disk in the instance template. Applicable to:\nadditional read-write disks, local SSDs, read-only disks.",
"Use the same source image used for creation of the source instance's\ncorresponding disk. The request will fail if the source VM's disk was\ncreated from a snapshot. Applicable to: boot disk, additional read-write\ndisks.",
"Use the same source image family used for creation of the source\ninstance's corresponding disk. The request will fail if the source image\nof the source disk does not belong to any image family. Applicable to:\nboot disk, additional read-write disks."
],
"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. [Output Only] Type of resource. Always compute#diskList for\nlists of disks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\npartial URL. For example, the following are all valid URLs to a zone:\n   \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.\nFor example, the following are all valid URLs to a disk:\n   \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"
},
"DiskParams": {
"description": "Additional disk params.",
"id": "DiskParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the disk. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"DiskResourceStatus": {
"id": "DiskResourceStatus",
"properties": {
"asyncPrimaryDisk": {
"$ref": "DiskResourceStatusAsyncReplicationStatus"
},
"asyncSecondaryDisks": {
"additionalProperties": {
"$ref": "DiskResourceStatusAsyncReplicationStatus"
},
"description": "Key: disk, value: AsyncReplicationStatus message",
"type": "object"
}
},
"type": "object"
},
"DiskResourceStatusAsyncReplicationStatus": {
"id": "DiskResourceStatusAsyncReplicationStatus",
"properties": {
"state": {
"enum": [
"ACTIVE",
"CREATED",
"STARTING",
"STATE_UNSPECIFIED",
"STOPPED",
"STOPPING"
],
"enumDescriptions": [
"Replication is active.",
"Secondary disk is created and is waiting for replication to start.",
"Replication is starting.",
"",
"Replication is stopped.",
"Replication is stopping."
],
"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/v1/regionDiskTypes)\n* [Zonal](/compute/docs/reference/rest/v1/diskTypes)\n\nYou can choose from a variety of disk types based on your needs.\nFor more information, readStorage options.\n\nThe diskTypes resource represents disk types for a zonal\npersistent disk.\nFor more information, readZonal persistent disks.\n\nThe regionDiskTypes resource represents disk types for a\nregional persistent disk. For more information, read Regional persistent disks.",
"id": "DiskType",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#diskType",
"description": "Output only. [Output Only] Type of the resource. Always compute#diskType\nfor disk types.",
"readOnly": true,
"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\napplicable for regional resources.\nYou must specify this field as part of the HTTP request URL. It is\nnot 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,\nsuch as \"10GB-10TB\".",
"type": "string"
},
"zone": {
"description": "[Output Only] URL of the zone where the disk type resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot 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. [Output Only] Type of resource. Alwayscompute#diskTypeAggregatedList.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#diskTypeList\nfor disk types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"DiskUpdateKmsKeyRequest": {
"id": "DiskUpdateKmsKeyRequest",
"properties": {
"kmsKeyName": {
"description": "Optional. The new KMS key to replace the current one on the disk. If empty, the disk\nwill be re-encrypted using the primary version of the disk's current KMS\nkey.\n\nThe KMS key can be provided in the following formats:\n   \n   \n     - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key\n\n\nWhere project is the project ID or\nproject number.",
"type": "string"
}
},
"type": "object"
},
"DisksAddResourcePoliciesRequest": {
"id": "DisksAddResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Full or relative path to the resource policy to be added to this disk. You\ncan only specify one resource policy.",
"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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"DisksStartAsyncReplicationRequest": {
"id": "DisksStartAsyncReplicationRequest",
"properties": {
"asyncSecondaryDisk": {
"description": "The secondary disk to start asynchronous replication to.\nYou can provide this as a partial or full URL to the resource. For example,\nthe following are valid values:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk\n     \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk\n     \n     - \n       projects/project/zones/zone/disks/disk\n     \n     - \n       projects/project/regions/region/disks/disk\n     \n     - \n       zones/zone/disks/disk\n     \n     - \n       regions/region/disks/disk",
"type": "string"
}
},
"type": "object"
},
"DisksStopGroupAsyncReplicationResource": {
"description": "A transient resource used in compute.disks.stopGroupAsyncReplication and\ncompute.regionDisks.stopGroupAsyncReplication. It is only used to process\nrequests and is not persisted.",
"id": "DisksStopGroupAsyncReplicationResource",
"properties": {
"resourcePolicy": {
"description": "The URL of the DiskConsistencyGroupPolicy for the group of disks to stop.\nThis may be a full or partial URL, such as:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n     \n     - \n       projects/project/regions/region/resourcePolicies/resourcePolicy\n     \n     - \n       regions/region/resourcePolicies/resourcePolicy",
"type": "string"
}
},
"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": {
"targetShape": {
"description": "The distribution shape to which the group converges either proactively or\non resize events (depending on the value set inupdatePolicy.instanceRedistributionType).",
"enum": [
"ANY",
"ANY_SINGLE_ZONE",
"BALANCED",
"EVEN"
],
"enumDescriptions": [
"The group picks zones for creating VM instances to fulfill the requested\nnumber of VMs within present resource constraints and to maximize\nutilization of unused zonal reservations. Recommended for batch workloads\nthat do not require high availability.",
"The group creates all VM instances within a single zone. The zone is\nselected based on the present resource constraints and to maximize\nutilization of unused zonal reservations.\nRecommended for batch workloads with heavy interprocess communication.",
"The group prioritizes acquisition of resources, scheduling VMs in zones\nwhere resources are available while distributing VMs as evenly as\npossible across selected zones to minimize the impact of zonal failure.\nRecommended for highly available serving workloads.",
"The group schedules VM instance creation and deletion to achieve and\nmaintain an even number of managed instances across the selected zones.\nThe distribution is even when the number of managed instances does not\ndiffer by more than 1 between any two zones. Recommended for highly\navailable serving workloads."
],
"type": "string"
},
"zones": {
"description": "Zones where the regional managed instance group will create and manage\nits instances.\nBy default, a regional MIG doesn't automatically select an AI zone to create\ninstances, even if an AI zone is available in the specified region. To\ncreate instances in an AI zone in the selected region, you must explicitly\nspecify it in the distribution policy together with the other preferred\nzones.",
"items": {
"$ref": "DistributionPolicyZoneConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"DistributionPolicyZoneConfiguration": {
"id": "DistributionPolicyZoneConfiguration",
"properties": {
"zone": {
"annotations": {
"required": [
"compute.regionInstanceGroupManagers.insert"
]
},
"description": "The URL of thezone.\nThe zone must exist in the region where the managed instance group is\nlocated.",
"type": "string"
}
},
"type": "object"
},
"Duration": {
"description": "A Duration represents a fixed-length span of time represented\nas a count of seconds and fractions of seconds at nanosecond\nresolution. It is independent of any calendar and concepts like \"day\"\nor \"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.\nDurations less than one second are represented with a 0\n`seconds` field and a positive `nanos` field. Must be from 0\nto 999,999,999 inclusive.",
"format": "int32",
"type": "integer"
},
"seconds": {
"description": "Span of time at a resolution of a second. Must be from 0\nto 315,576,000,000 inclusive. Note: these bounds are computed from:\n60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"ErrorInfo": {
"description": "Describes the cause of the error with structured details.\n\nExample of an error when contacting the \"pubsub.googleapis.com\" API when it\nis not enabled:\n\n    { \"reason\": \"API_DISABLED\"\n      \"domain\": \"googleapis.com\"\n      \"metadata\": {\n        \"resource\": \"projects/123\",\n        \"service\": \"pubsub.googleapis.com\"\n      }\n    }\n\nThis response indicates that the pubsub.googleapis.com API is not enabled.\n\nExample of an error that is returned when attempting to create a Spanner\ninstance in a region that is out of stock:\n\n    { \"reason\": \"STOCKOUT\"\n      \"domain\": \"spanner.googleapis.com\",\n      \"metadata\": {\n        \"availableRegions\": \"us-central1,us-east2\"\n      }\n    }",
"id": "ErrorInfo",
"properties": {
"domain": {
"description": "The logical grouping to which the \"reason\" belongs. The error domain\nis typically the registered service name of the tool or product that\ngenerates the error. Example: \"pubsub.googleapis.com\". If the error is\ngenerated by some common infrastructure, the error domain must be a\nglobally unique value that identifies the infrastructure. For Google API\ninfrastructure, the error domain is \"googleapis.com\".",
"type": "string"
},
"metadatas": {
"additionalProperties": {
"type": "string"
},
"description": "Additional structured details about this error.\n\nKeys must match a regular expression of `a-z+` but should\nideally be lowerCamelCase. Also, they must be limited to 64 characters in\nlength. When identifying the current value of an exceeded limit, the units\nshould be contained in the key, not the value.  For example, rather than\n`{\"instanceLimit\": \"100/request\"}`, should be returned as,\n`{\"instanceLimitPerRequest\": \"100\"}`, if the client exceeds the number of\ninstances that can be created in a single (batch) request.",
"type": "object"
},
"reason": {
"description": "The reason of the error. This is a constant value that identifies the\nproximate cause of the error. Error reasons are unique within a particular\ndomain of errors. This should be at most 63 characters and match a\nregular expression of `A-Z+[A-Z0-9]`, which represents\nUPPER_SNAKE_CASE.",
"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\nhappens if the field networkPeering.importCustomRoutes is true\nfor this network, and networkPeering.exportCustomRoutes is\ntrue for the peer network, and the import does not result in a route\nconflict.",
"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": [
"For routes exported from local network.",
"The peering route.",
"The peering route corresponding to subnetwork range."
],
"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. [Output Only] Type of resource. Alwayscompute#exchangedPeeringRoutesList for exchanged peering\nroutes lists.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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)\nsyntax. CEL is a C-like expression language. The syntax and semantics of CEL\nare documented at https://github.com/google/cel-spec.\n\nExample (Comparison):\n\n    title: \"Summary size limit\"\n    description: \"Determines if a summary is less than 100 chars\"\n    expression: \"document.summary.size() < 100\"\n\nExample (Equality):\n\n    title: \"Requestor is owner\"\n    description: \"Determines if requestor is the document owner\"\n    expression: \"document.owner == request.auth.claims.email\"\n\nExample (Logic):\n\n    title: \"Public documents\"\n    description: \"Determine whether the document should be publicly visible\"\n    expression: \"document.type != 'private' && document.type != 'internal'\"\n\nExample (Data Manipulation):\n\n    title: \"Notification string\"\n    description: \"Create a notification string with a timestamp.\"\n    expression: \"'New message received at ' + string(document.create_time)\"\n\nThe exact variables and functions that may be referenced within an expression\nare determined by the service that evaluates it. See the service\ndocumentation for additional information.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language\nsyntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error\nreporting, 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\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.",
"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\nprovider's VPN gateway that connects to your Google Cloud VPN gateway.\n\nTo create a highly available VPN from Google Cloud Platform to your\nVPN gateway or another cloud provider's VPN gateway, you must create a\nexternal VPN gateway resource with information about the other gateway.\n\nFor more information about using external VPN gateways, see\nCreating an HA VPN gateway and tunnel pair to a peer VPN.",
"id": "ExternalVpnGateway",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"interfaces": {
"description": "A list of interfaces for this external VPN gateway.\n\nIf your peer-side gateway is an on-premises gateway and non-AWS cloud\nproviders' gateway, at most two interfaces can be provided for an external\nVPN gateway. If your peer side is an AWS virtual private gateway, four\ninterfaces should be provided for an external VPN gateway.",
"items": {
"$ref": "ExternalVpnGatewayInterface"
},
"type": "array"
},
"kind": {
"default": "compute#externalVpnGateway",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#externalVpnGateway for externalVpnGateways.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this ExternalVpnGateway,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an ExternalVpnGateway.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel 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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "ExternalVpnGatewayParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"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": [
"The external VPN gateway has four public IP addresses; at the time of\nwriting this API, the AWS virtual private gateway is an example which has\nfour public IP addresses for high availability connections; there should\nbe two VPN connections in the AWS virtual private gateway , each AWS VPN\nconnection has two public IP addresses;  please make sure to put two\npublic IP addresses from one AWS VPN connection into interfaces 0 and 1\nof this external VPN gateway, and put the other two public IP addresses\nfrom another AWS VPN connection into interfaces 2 and 3 of this external\nVPN gateway. When displaying highly available configuration status\nfor the VPN tunnels connected to FOUR_IPS_REDUNDANCY external VPN\ngateway, Google will always detect whether interfaces 0 and 1 are\nconnected on one interface of HA Cloud VPN gateway, and detect whether\ninterfaces 2 and 3 are connected to another interface of the HA Cloud VPN\ngateway.",
"The external VPN gateway has only one public IP address which internally\nprovide redundancy or failover.",
"The external VPN gateway has two public IP addresses which are redundant\nwith each other, the following two types of setup on your on-premises\nside would have this type of redundancy:\n(1) Two separate on-premises gateways, each with one public IP address,\n    the two on-premises gateways are redundant with each other.\n(2) A single on-premise gateway with two public IP addresses that are\n    redundant with eatch other."
],
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ExternalVpnGatewayInterface": {
"description": "The interface for the external VPN gateway.",
"id": "ExternalVpnGatewayInterface",
"properties": {
"id": {
"description": "The numeric ID of this interface.\nThe allowed input values for this id for different redundancy types of\nexternal VPN gateway:\n   \n   - SINGLE_IP_INTERNALLY_REDUNDANT - 0\n   - TWO_IPS_REDUNDANCY - 0, 1\n   - 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\nsupported. This IP address can be either from your on-premise gateway or\nanother Cloud provider's VPN gateway, it cannot be an IP address from\nGoogle Compute Engine.",
"type": "string"
},
"ipv6Address": {
"description": "IPv6 address of the interface in the external VPN gateway. This IPv6\naddress can be either from your on-premise gateway or another Cloud\nprovider's VPN gateway, it cannot be an IP address from Google Compute\nEngine. Must specify an IPv6 address (not IPV4-mapped) using any format\ndescribed in RFC 4291 (e.g. 2001:db8:0:0:2d9:51:0:0). The output format\nis RFC 5952 format (e.g. 2001:db8::2d9:51:0:0).",
"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. [Output Only] Type of resource. Always compute#externalVpnGatewayList for lists of externalVpnGateways.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ExternalVpnGatewayParams": {
"id": "ExternalVpnGatewayParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"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\ninstances. For more information, readFirewall rules.",
"id": "Firewall",
"properties": {
"allowed": {
"description": "The list of ALLOW rules specified by this firewall. Each rule specifies a\nprotocol 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\nrequired when creating a firewall rule. This value can either be one of the\nfollowing 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.\nThis field is only applicable for the UDP or TCP protocol.\nEach entry must be either an integer or a range.\nIf not specified, this rule applies to connections through any port.\n\nExample inputs include: [\"22\"], [\"80\",\"443\"],\nand [\"12345-12349\"].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"denied": {
"description": "The list of DENY rules specified by this firewall. Each rule specifies a\nprotocol 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\nrequired when creating a firewall rule. This value can either be one of the\nfollowing 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.\nThis field is only applicable for the UDP or TCP protocol.\nEach entry must be either an integer or a range.\nIf not specified, this rule applies to connections through any port.\n\nExample inputs include: [\"22\"], [\"80\",\"443\"],\nand [\"12345-12349\"].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this field when you\ncreate the resource.",
"type": "string"
},
"destinationRanges": {
"description": "If destination ranges are specified, the firewall rule applies only to\ntraffic that has destination IP address in these ranges. These ranges must\nbe expressed inCIDR format. Both IPv4 and IPv6 are supported.",
"items": {
"type": "string"
},
"type": "array"
},
"direction": {
"description": "Direction of traffic to which this firewall applies, either `INGRESS` or\n`EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot\nspecify the sourceTags fields.",
"enum": [
"EGRESS",
"INGRESS"
],
"enumDescriptions": [
"Indicates that firewall should apply to outgoing traffic.",
"Indicates that firewall should apply to incoming traffic."
],
"type": "string"
},
"disabled": {
"description": "Denotes whether the firewall rule is disabled. When set to true, the\nfirewall rule is not enforced and the network behaves as if it did not\nexist. If this is unspecified, the firewall rule will be enabled.",
"type": "boolean"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#firewall",
"description": "Output only. [Output Only] Type of the resource. Always compute#firewall\nfor firewall rules.",
"readOnly": true,
"type": "string"
},
"logConfig": {
"$ref": "FirewallLogConfig",
"description": "This field denotes the logging options for a particular firewall rule. If\nlogging is enabled, logs will be exported to Cloud Logging."
},
"name": {
"annotations": {
"required": [
"compute.firewalls.insert",
"compute.firewalls.patch"
]
},
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character\nmust be a lowercase letter, and all following characters (except for the\nlast character) must be a dash, lowercase letter, or digit. The last\ncharacter 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\nspecified when creating a firewall rule, the default network\nis used:\n\nglobal/networks/default\n\nIf you choose to specify this field, you can specify the network as a full \nor partial URL. For example, the following are all valid URLs: \n   \n   - \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"
},
"params": {
"$ref": "FirewallParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"priority": {
"description": "Priority for this rule.\nThis is an integer between `0` and `65535`, both inclusive.\nThe default value is `1000`.\nRelative priorities determine which rule takes effect if multiple rules\napply. Lower values indicate higher priority. For example, a rule with\npriority `0` has higher precedence than a rule with priority `1`.\nDENY rules take precedence over ALLOW rules if they have equal priority.\nNote that VPC networks have implied\nrules with a priority of `65535`. To avoid conflicts with the implied\nrules, 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\nthat has a source IP address in these ranges. These ranges must be\nexpressed inCIDR format. One or both of sourceRanges\nand sourceTags may be set.\nIf both fields are set, the rule applies to traffic that has a\nsource IP address within sourceRanges OR a source IP\nfrom a resource with a matching tag listed in thesourceTags field. The connection does not need to match\nboth fields for the rule to\napply. Both IPv4 and IPv6 are supported.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceServiceAccounts": {
"description": "If source service accounts are specified, the firewall rules apply only to\ntraffic originating from an instance with a service account in this list.\nSource service accounts cannot be used to control traffic to an instance's\nexternal IP address because service accounts are associated with an\ninstance, not an IP address.sourceRanges can be set at the same time assourceServiceAccounts.\nIf both are set, the firewall applies to traffic that\nhas a source IP address within the sourceRanges OR a source\nIP that belongs to an instance with service account listed insourceServiceAccount. The connection does not need to match\nboth fields for the firewall to apply.sourceServiceAccounts cannot be used at the same time assourceTags or targetTags.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceTags": {
"description": "If source tags are specified, the firewall rule applies only to traffic\nwith source IPs that match the primary network interfaces of VM instances\nthat have the tag and are in the same VPC network.\nSource tags cannot be used to control traffic to an instance's external IP\naddress, it only applies to traffic between instances in the same virtual\nnetwork. Because tags are associated with instances, not IP addresses.\nOne or both of sourceRanges and sourceTags may be\nset. If both fields are set, the firewall applies to traffic that has a\nsource IP address within sourceRanges OR a source IP from a\nresource with a matching tag listed in the sourceTags\nfield. The connection does not need to match both fields for the\nfirewall to apply.",
"items": {
"type": "string"
},
"type": "array"
},
"targetServiceAccounts": {
"description": "A list of service accounts indicating sets of instances located in the\nnetwork that may make network connections as specified inallowed[].targetServiceAccounts cannot be used at the same time astargetTags or sourceTags.\nIf neither targetServiceAccounts nor targetTags\nare specified, the firewall rule applies to all instances on the specified\nnetwork.",
"items": {
"type": "string"
},
"type": "array"
},
"targetTags": {
"description": "A list of tags that controls which instances the firewall rule\napplies to. If targetTags are specified, then the firewall\nrule applies only to instances in the VPC network that have one of those\ntags. If no targetTags are specified, the firewall rule\napplies 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. [Output Only] Type of resource. Always compute#firewallList\nfor lists of firewalls.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nrule.",
"type": "boolean"
},
"metadata": {
"description": "This field can only be specified for a particular firewall rule if\nlogging is enabled for that rule. This field denotes whether to include\nor exclude metadata for firewall logs.",
"enum": [
"EXCLUDE_ALL_METADATA",
"INCLUDE_ALL_METADATA"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"FirewallParams": {
"description": "Additional firewall parameters.",
"id": "FirewallParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"FirewallPoliciesListAssociationsResponse": {
"id": "FirewallPoliciesListAssociationsResponse",
"properties": {
"associations": {
"description": "A list of associations.",
"items": {
"$ref": "FirewallPolicyAssociation"
},
"type": "array"
},
"kind": {
"default": "compute#firewallPoliciesListAssociationsResponse",
"description": "Output only. [Output Only] Type of firewallPolicy associations. Alwayscompute#FirewallPoliciesListAssociations for lists of\nfirewallPolicy associations.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"FirewallPoliciesScopedList": {
"id": "FirewallPoliciesScopedList",
"properties": {
"firewallPolicies": {
"description": "A list of firewall policies contained in this scope.",
"items": {
"$ref": "FirewallPolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of firewall policies when\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FirewallPolicy": {
"description": "Represents a Firewall Policy resource.",
"id": "FirewallPolicy",
"properties": {
"associations": {
"description": "A list of associations that belong to this firewall policy.",
"items": {
"$ref": "FirewallPolicyAssociation"
},
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"displayName": {
"deprecated": true,
"description": "Deprecated, please use short name instead. User-provided name of the\nOrganization firewall policy. The name should be unique in the organization\nin which the firewall policy is created.\nThis field is not applicable to network firewall policies.\nThis name must be set on creation and cannot be changed.\nThe name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which\nmeans the first character must be a lowercase letter, and all following\ncharacters must be a dash, lowercase letter, or digit, except the last\ncharacter, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"fingerprint": {
"description": "Specifies a fingerprint for this resource, which is essentially a hash of\nthe metadata's contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update metadata. You must always provide an\nup-to-date fingerprint hash in order to update or change metadata,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make get() request to the\nfirewall policy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#firewallPolicy",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#firewallPolicyfor firewall policies",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. For Organization Firewall Policies it's a\n[Output Only] numeric ID allocated by Google Cloud which uniquely\nidentifies the Organization Firewall Policy.",
"type": "string"
},
"packetMirroringRules": {
"description": "A list of packet mirroring rules that belong to this policy.",
"items": {
"$ref": "FirewallPolicyRule"
},
"type": "array"
},
"parent": {
"description": "Output only. [Output Only] The parent of the firewall policy.\nThis field is not applicable to network firewall policies.",
"readOnly": true,
"type": "string"
},
"policyType": {
"description": "The type of the firewall policy. This field can be one of\nVPC_POLICY, RDMA_ROCE_POLICY or ULL_POLICY.\n\nNote: if not specified then VPC_POLICY will be used.",
"enum": [
"RDMA_ROCE_POLICY",
"ULL_POLICY",
"VPC_POLICY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional firewall policy resides.\nThis field is not applicable to global firewall policies.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"ruleTupleCount": {
"description": "Output only. [Output Only] Total count of all firewall policy rule tuples. A firewall\npolicy can not exceed a set number of tuples.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"rules": {
"description": "A list of rules that belong to this policy.\nThere must always be a default rule (rule with priority 2147483647 and\nmatch \"*\"). If no rules are provided when creating a firewall policy, a\ndefault rule with action \"allow\" will be added.",
"items": {
"$ref": "FirewallPolicyRule"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"shortName": {
"description": "User-provided name of the Organization firewall policy. The name should be\nunique in the organization in which the firewall policy is created.\nThis field is not applicable to network firewall policies.\nThis name must be set on creation and cannot be changed. The name must be\n1-63 characters long, and comply with RFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
}
},
"type": "object"
},
"FirewallPolicyAssociation": {
"id": "FirewallPolicyAssociation",
"properties": {
"attachmentTarget": {
"description": "The target that the firewall policy is attached to.",
"type": "string"
},
"displayName": {
"deprecated": true,
"description": "[Output Only] Deprecated, please use short name instead. The display name\nof the firewall policy of the association.",
"type": "string"
},
"firewallPolicyId": {
"description": "Output only. [Output Only] The firewall policy ID of the association.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name for an association.",
"type": "string"
},
"shortName": {
"description": "Output only. [Output Only] The short name of the firewall policy of the association.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"FirewallPolicyList": {
"id": "FirewallPolicyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of FirewallPolicy resources.",
"items": {
"$ref": "FirewallPolicy"
},
"type": "array"
},
"kind": {
"default": "compute#firewallPolicyList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#firewallPolicyList for listsof FirewallPolicies",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FirewallPolicyRule": {
"description": "Represents a rule that describes one or more match conditions along with\nthe action to be taken when traffic matches this condition (allow or deny).",
"id": "FirewallPolicyRule",
"properties": {
"action": {
"description": "The Action to perform when the client connection triggers the rule.\nValid actions for firewall rules are: \"allow\", \"deny\",\n\"apply_security_profile_group\" and \"goto_next\".\nValid actions for packet mirroring rules are: \"mirror\", \"do_not_mirror\"\nand \"goto_next\".",
"type": "string"
},
"description": {
"description": "An optional description for this resource.",
"type": "string"
},
"direction": {
"description": "The direction in which this rule applies.",
"enum": [
"EGRESS",
"INGRESS"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"disabled": {
"description": "Denotes whether the firewall policy rule is disabled. When set to true,\nthe firewall policy rule is not enforced and traffic behaves as if it did\nnot exist. If this is unspecified, the firewall policy rule will be\nenabled.",
"type": "boolean"
},
"enableLogging": {
"description": "Denotes whether to enable logging for a particular rule. If logging is\nenabled, logs will be exported to the configured export destination in\nStackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you\ncannot enable logging on \"goto_next\" rules.",
"type": "boolean"
},
"kind": {
"default": "compute#firewallPolicyRule",
"description": "Output only. [Output only] Type of the resource. Returnscompute#firewallPolicyRule for firewall rules andcompute#packetMirroringRule for packet mirroring rules.",
"readOnly": true,
"type": "string"
},
"match": {
"$ref": "FirewallPolicyRuleMatcher",
"description": "A match condition that incoming traffic is evaluated against.\nIf it evaluates to true, the corresponding 'action' is enforced."
},
"priority": {
"description": "An integer indicating the priority of a rule in the list. The priority\nmust be a positive value between 0 and 2147483647.\nRules are evaluated from highest to lowest priority where 0 is the\nhighest priority and 2147483647 is the lowest priority.",
"format": "int32",
"type": "integer"
},
"ruleName": {
"description": "An optional name for the rule. This field is not a unique identifier\nand can be updated.",
"type": "string"
},
"ruleTupleCount": {
"description": "Output only. [Output Only] Calculation of the complexity of a single firewall policy\nrule.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"securityProfileGroup": {
"description": "A fully-qualified URL of a SecurityProfile resource instance.\nExample:\nhttps://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group\nMust be specified if action is one of 'apply_security_profile_group' or\n'mirror'. Cannot be specified for other actions.",
"type": "string"
},
"targetResources": {
"description": "A list of network resource URLs to which this rule applies.  This field\nallows you to control which network's VMs get this rule.  If this field\nis left blank, all VMs within the organization will receive the rule.",
"items": {
"type": "string"
},
"type": "array"
},
"targetSecureTags": {
"description": "A list of secure tags that controls which instances the firewall rule\napplies to. If targetSecureTag are specified, then the\nfirewall rule applies only to instances in the VPC network that have one\nof those EFFECTIVE secure tags, if all the target_secure_tag are in\nINEFFECTIVE state, then this rule will be ignored.targetSecureTag may not be set at the same time astargetServiceAccounts.\nIf neither targetServiceAccounts nortargetSecureTag are specified, the firewall rule applies\nto all instances on the specified network.\nMaximum number of target label tags allowed is 256.",
"items": {
"$ref": "FirewallPolicyRuleSecureTag"
},
"type": "array"
},
"targetServiceAccounts": {
"description": "A list of service accounts indicating the sets of instances that are\napplied with this rule.",
"items": {
"type": "string"
},
"type": "array"
},
"tlsInspect": {
"description": "Boolean flag indicating if the traffic should be TLS decrypted.\nCan be set only if action = 'apply_security_profile_group' and cannot\nbe set for other actions.",
"type": "boolean"
}
},
"type": "object"
},
"FirewallPolicyRuleMatcher": {
"description": "Represents a match condition that incoming traffic is evaluated against.\nExactly one field must be specified.",
"id": "FirewallPolicyRuleMatcher",
"properties": {
"destAddressGroups": {
"description": "Address groups which should be matched against the traffic destination.\nMaximum number of destination address groups is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"destFqdns": {
"description": "Fully Qualified Domain Name (FQDN) which should be matched against\ntraffic destination.\nMaximum number of destination fqdn allowed is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"destIpRanges": {
"description": "CIDR IP address range.\nMaximum number of destination CIDR IP ranges allowed is 5000.",
"items": {
"type": "string"
},
"type": "array"
},
"destNetworkContext": {
"description": "Network context of the traffic destination. Allowed values are:\n   \n   \n     - UNSPECIFIED\n     - INTERNET\n     - NON_INTERNET",
"enum": [
"INTERNET",
"INTRA_VPC",
"NON_INTERNET",
"UNSPECIFIED",
"VPC_NETWORKS"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"destNetworkType": {
"description": "Network type of the traffic destination. Allowed values are:\n   \n   \n     - UNSPECIFIED\n     - INTERNET\n     - NON_INTERNET",
"enum": [
"INTERNET",
"INTRA_VPC",
"NON_INTERNET",
"UNSPECIFIED",
"VPC_NETWORKS"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"destRegionCodes": {
"description": "Region codes whose IP addresses will be used to match for destination\nof traffic. Should be specified as 2 letter country code defined as per\nISO 3166 alpha-2 country codes. ex.\"US\"\nMaximum number of dest region codes allowed is 5000.",
"items": {
"type": "string"
},
"type": "array"
},
"destThreatIntelligences": {
"description": "Names of Network Threat Intelligence lists.\nThe IPs in these lists will be matched against traffic destination.",
"items": {
"type": "string"
},
"type": "array"
},
"layer4Configs": {
"description": "Pairs of IP protocols and ports that the rule should match.",
"items": {
"$ref": "FirewallPolicyRuleMatcherLayer4Config"
},
"type": "array"
},
"srcAddressGroups": {
"description": "Address groups which should be matched against the traffic source.\nMaximum number of source address groups is 10.",
"items": {
"type": "string"
},
"type": "array"
},
"srcFqdns": {
"description": "Fully Qualified Domain Name (FQDN) which should be matched against\ntraffic source.\nMaximum number of source fqdn allowed is 100.",
"items": {
"type": "string"
},
"type": "array"
},
"srcIpRanges": {
"description": "CIDR IP address range.\nMaximum number of source CIDR IP ranges allowed is 5000.",
"items": {
"type": "string"
},
"type": "array"
},
"srcNetworkContext": {
"description": "Network context of the traffic source. Allowed values are:\n   \n   \n     - UNSPECIFIED\n     - INTERNET\n     - INTRA_VPC\n     - NON_INTERNET\n     - VPC_NETWORKS",
"enum": [
"INTERNET",
"INTRA_VPC",
"NON_INTERNET",
"UNSPECIFIED",
"VPC_NETWORKS"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"srcNetworkType": {
"description": "Network type of the traffic source. Allowed values are:\n   \n   \n     - UNSPECIFIED\n     - INTERNET\n     - INTRA_VPC\n     - NON_INTERNET\n     - VPC_NETWORKS",
"enum": [
"INTERNET",
"INTRA_VPC",
"NON_INTERNET",
"UNSPECIFIED",
"VPC_NETWORKS"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"type": "string"
},
"srcNetworks": {
"description": "Networks of the traffic source. It can be either a full or partial url.",
"items": {
"type": "string"
},
"type": "array"
},
"srcRegionCodes": {
"description": "Region codes whose IP addresses will be used to match for source\nof traffic. Should be specified as 2 letter country code defined as per\nISO 3166 alpha-2 country codes. ex.\"US\"\nMaximum number of source region codes allowed is 5000.",
"items": {
"type": "string"
},
"type": "array"
},
"srcSecureTags": {
"description": "List of secure tag values, which should be matched at the source\nof the traffic.\nFor INGRESS rule, if all the srcSecureTag are INEFFECTIVE,\nand there is no srcIpRange, this rule will be ignored.\nMaximum number of source tag values allowed is 256.",
"items": {
"$ref": "FirewallPolicyRuleSecureTag"
},
"type": "array"
},
"srcThreatIntelligences": {
"description": "Names of Network Threat Intelligence lists.\nThe IPs in these lists will be matched against traffic source.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FirewallPolicyRuleMatcherLayer4Config": {
"id": "FirewallPolicyRuleMatcherLayer4Config",
"properties": {
"ipProtocol": {
"description": "The IP protocol to which this rule applies. The protocol type is\nrequired when creating a firewall rule. This value can either be\none of the following well known protocol strings (tcp,udp, icmp, esp,ah, ipip, sctp), or the IP\nprotocol number.",
"type": "string"
},
"ports": {
"description": "An optional list of ports to which this rule applies. This field is\nonly applicable for UDP or TCP protocol. Each entry must be either\nan integer or a range. If not specified, this rule applies to\nconnections through any port.\n\nExample inputs include: [\"22\"],[\"80\",\"443\"], and [\"12345-12349\"].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"FirewallPolicyRuleSecureTag": {
"id": "FirewallPolicyRuleSecureTag",
"properties": {
"name": {
"description": "Name of the secure tag, created with TagManager's TagValue API.",
"pattern": "tagValues/[0-9]+",
"type": "string"
},
"state": {
"description": "Output only. [Output Only] State of the secure tag, either `EFFECTIVE` or\n`INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted\nor its network is deleted.",
"enum": [
"EFFECTIVE",
"INEFFECTIVE"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
}
},
"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   \n    - If the value is fixed, then the calculated\n     value is equal to the fixed value.\n    - If the value is a percent, then the\n    calculated\n     value is percent/100 * targetSize. For example,\n     the calculated value of a 80% of a managed instance group\n     with 150 instances would be (80/100 * 150) = 120 VM instances. If there\n     is a remainder, the number is rounded.",
"format": "int32",
"readOnly": true,
"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\nexample, specify 80 for 80%.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"FlexibleTimeRange": {
"description": "Specifies a flexible time range with flexible start time and duration.\n\nIt is possible to specify a contradictory time range that cannot be matched\nby any Interval. This causes a validation error.",
"id": "FlexibleTimeRange",
"properties": {
"maxDuration": {
"format": "google-duration",
"type": "string"
},
"minDuration": {
"format": "google-duration",
"type": "string"
},
"startTimeNotEarlierThan": {
"format": "google-datetime",
"type": "string"
},
"startTimeNotLaterThan": {
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"ForwardingRule": {
"description": "Represents a Forwarding Rule resource.\n\nForwarding rule resources in Google Cloud can be either regional or global in\nscope:\n\n* [Global](https://cloud.google.com/compute/docs/reference/rest/v1/globalForwardingRules)\n* [Regional](https://cloud.google.com/compute/docs/reference/rest/v1/forwardingRules)\n\nA forwarding rule and its corresponding IP address represent the frontend\nconfiguration of a Google Cloud load balancer.\nForwarding rules can also reference target instances and Cloud VPN Classic\ngateways (targetVpnGateway).\n\nFor more information, read\nForwarding rule concepts and\nUsing protocol forwarding.",
"id": "ForwardingRule",
"properties": {
"IPAddress": {
"description": "IP address for which this forwarding rule accepts traffic. When a client\nsends traffic to this IP address, the forwarding rule directs the traffic\nto the referenced target or backendService.\nWhile creating a forwarding rule, specifying an IPAddress is\nrequired under the following circumstances:\n\n   \n   - When the target is set to targetGrpcProxy andvalidateForProxyless is set to true, theIPAddress should be set to 0.0.0.0.\n   - When the target is a Private Service Connect Google APIs\n   bundle, you must specify an IPAddress.\n\n\nOtherwise, you can optionally specify an IP address that references an\nexisting static (reserved) IP address resource. When omitted, Google Cloud\nassigns an ephemeral IP address.\n\nUse one of the following formats to specify an IP address while creating a\nforwarding rule:\n\n* IP address number, as in `100.1.2.3`\n* IPv6 address range, as in `2600:1234::/96`\n* Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/addresses/address-name\n* Partial URL or by name, as in:\n   \n   - projects/project_id/regions/region/addresses/address-name\n   - regions/region/addresses/address-name\n   - global/addresses/address-name\n   - address-name\n\n\n\nThe forwarding rule's target or backendService,\nand in most cases, also the loadBalancingScheme, determine the\ntype of IP address that you can use. For detailed information, see\n[IP address\nspecifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n\nWhen reading an IPAddress, the API always returns the IP\naddress number.",
"type": "string"
},
"IPProtocol": {
"description": "The IP protocol to which this rule applies.\n\nFor protocol forwarding, valid\noptions are TCP, UDP, ESP,AH, SCTP, ICMP andL3_DEFAULT.\n\nThe valid IP protocols are different for different load balancing products\nas described in [Load balancing\nfeatures](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends).",
"enum": [
"AH",
"ESP",
"ICMP",
"L3_DEFAULT",
"SCTP",
"TCP",
"UDP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"allPorts": {
"description": "The ports, portRange, and allPorts\nfields are mutually exclusive. Only packets addressed to ports in the\nspecified range will be forwarded to the backends configured with this\nforwarding rule.\n\nThe allPorts field has the following limitations:\n   \n   - It requires that the forwarding rule IPProtocol be TCP,\n   UDP, SCTP, or L3_DEFAULT.\n   - It's applicable only to the following products: internal passthrough\n   Network Load Balancers, backend service-based external passthrough Network\n   Load Balancers, and internal and external protocol forwarding.\n   - Set this field to true to allow packets addressed to any port or\n   packets lacking destination port information (for example, UDP fragments\n   after the first fragment) to be forwarded to the backends configured with\n   this forwarding rule. The L3_DEFAULT protocol requiresallPorts be set to true.",
"type": "boolean"
},
"allowGlobalAccess": {
"description": "If set to true, clients can access the internal passthrough Network Load\nBalancers, the regional internal Application Load Balancer, and the\nregional internal proxy Network Load Balancer from all regions.\nIf false, only allows access from the local region the load balancer is\nlocated at. Note that for INTERNAL_MANAGED forwarding rules, this field\ncannot be changed after the forwarding rule is created.",
"type": "boolean"
},
"allowPscGlobalAccess": {
"description": "This is used in PSC consumer ForwardingRule to control whether the PSC\nendpoint can be accessed from another region.",
"type": "boolean"
},
"backendService": {
"description": "Identifies the backend service to which the forwarding rule sends traffic.\nRequired for internal and external passthrough Network Load Balancers;\nmust be omitted for all other load balancer types.",
"type": "string"
},
"baseForwardingRule": {
"description": "Output only. [Output Only] The URL for the corresponding base forwarding rule. By base\nforwarding rule, we mean the forwarding rule that has the same IP address,\nprotocol, and port settings with the current forwarding rule, but without\nsourceIPRanges specified.\nAlways empty if the current forwarding rule does not have sourceIPRanges\nspecified.",
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"externalManagedBackendBucketMigrationState": {
"description": "Specifies the canary migration state for the backend buckets attached to\nthis forwarding rule. Possible values are PREPARE, TEST_BY_PERCENTAGE, and\nTEST_ALL_TRAFFIC.\n\nTo begin the migration from EXTERNAL to EXTERNAL_MANAGED, the state must be\nchanged to PREPARE. The state must be changed to TEST_ALL_TRAFFIC before\nthe loadBalancingScheme can be changed to EXTERNAL_MANAGED. Optionally, the\nTEST_BY_PERCENTAGE state can be used to migrate traffic to backend buckets\nattached to this forwarding rule by percentage using\nexternalManagedBackendBucketMigrationTestingPercentage.\n\nRolling back a migration requires the states to be set in reverse order. So\nchanging the scheme from EXTERNAL_MANAGED to EXTERNAL requires the state to\nbe set to TEST_ALL_TRAFFIC at the same time. Optionally, the\nTEST_BY_PERCENTAGE state can be used to migrate some traffic back to\nEXTERNAL or PREPARE can be used to migrate all traffic back to EXTERNAL.",
"enum": [
"PREPARE",
"TEST_ALL_TRAFFIC",
"TEST_BY_PERCENTAGE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"externalManagedBackendBucketMigrationTestingPercentage": {
"description": "Determines the fraction of requests to backend buckets that should be\nprocessed by the global external Application Load Balancer.\n\nThe value of this field must be in the range [0, 100].\n\nThis value can only be set if the loadBalancingScheme in the BackendService\nis set to EXTERNAL (when using the classic Application Load Balancer) and\nthe migration state is TEST_BY_PERCENTAGE.",
"format": "float",
"type": "number"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a ForwardingRule. Include the fingerprint in patch request to\nensure that you do not overwrite changes that were applied from another\nconcurrent request.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a ForwardingRule.",
"format": "byte",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"ipCollection": {
"description": "Resource reference of a PublicDelegatedPrefix. The PDP must\nbe a sub-PDP in EXTERNAL_IPV6_FORWARDING_RULE_CREATION mode.\n\nUse one of the following formats to specify a sub-PDP when creating an IPv6\nNetLB forwarding rule using BYOIP:\nFull resource URL, as inhttps://www.googleapis.com/compute/v1/projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name\nPartial URL, as in:\n   \n   - projects/project_id/regions/region/publicDelegatedPrefixes/sub-pdp-name\n   - regions/region/publicDelegatedPrefixes/sub-pdp-name",
"type": "string"
},
"ipVersion": {
"description": "The IP Version that will be used by this forwarding rule.  Valid options\nare IPV4 or IPV6.",
"enum": [
"IPV4",
"IPV6",
"UNSPECIFIED_VERSION"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"isMirroringCollector": {
"description": "Indicates whether or not this load balancer can be used as a collector for\npacket mirroring. To prevent mirroring loops, instances behind this\nload balancer will not have their traffic mirrored even if aPacketMirroring rule applies to them.\nThis can only be set to true for load balancers that have theirloadBalancingScheme set to INTERNAL.",
"type": "boolean"
},
"kind": {
"default": "compute#forwardingRule",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#forwardingRule for forwarding rule resources.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this resource, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a ForwardingRule.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"loadBalancingScheme": {
"description": "Specifies the forwarding rule type.\n\nFor more information about forwarding rules, refer to\nForwarding rule concepts.",
"enum": [
"EXTERNAL",
"EXTERNAL_MANAGED",
"INTERNAL",
"INTERNAL_MANAGED",
"INTERNAL_SELF_MANAGED",
"INVALID"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"metadataFilters": {
"description": "Opaque filter criteria used by load balancer to restrict routing\nconfiguration to a limited set of xDS\ncompliant clients. In their xDS requests to load balancer, xDS clients\npresent node\nmetadata. When there is a match, the relevant configuration\nis made available to those proxies. Otherwise, all the resources (e.g.TargetHttpProxy, UrlMap)\nreferenced by the ForwardingRule are not visible to\nthose proxies.\n\nFor each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in\nthe metadata. If its filterMatchCriteria is set to\nMATCH_ALL, then all of its filterLabels must match with\ncorresponding labels provided in the metadata. If multiplemetadataFilters are specified, all of them need to be satisfied\nin order to be considered a match.\n\nmetadataFilters specified here will be applifed before\nthose specified in the UrlMap that thisForwardingRule references.\n\nmetadataFilters only applies to Loadbalancers that have\ntheir loadBalancingScheme set toINTERNAL_SELF_MANAGED.",
"items": {
"$ref": "MetadataFilter"
},
"type": "array"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, the forwarding rule name must be a 1-20 characters string with\nlowercase letters and numbers and must start with a letter.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "This field is not used for global external load balancing.\n\nFor internal passthrough Network Load Balancers, this field identifies the\nnetwork that the load balanced IP should belong to for this forwarding\nrule.\nIf the subnetwork is specified, the network of the subnetwork will be used.\nIf neither subnetwork nor this field is specified, the default network will\nbe used.\n\nFor Private Service Connect forwarding rules that forward traffic to Google\nAPIs, a network must be provided.",
"type": "string"
},
"networkTier": {
"description": "This signifies the networking tier used for configuring\nthis load balancer and can only take the following values:PREMIUM, STANDARD.\n\nFor regional ForwardingRule, the valid values are PREMIUM andSTANDARD. For GlobalForwardingRule, the valid value isPREMIUM.\n\nIf this field is not specified, it is assumed to be PREMIUM.\nIf IPAddress is specified, this value must be equal to the\nnetworkTier of the Address.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"type": "string"
},
"noAutomateDnsZone": {
"description": "This is used in PSC consumer ForwardingRule to control whether it should\ntry to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use\nthis field. Once set, this field is not mutable.",
"type": "boolean"
},
"portRange": {
"description": "The ports, portRange, and allPorts\nfields are mutually exclusive. Only packets addressed to ports in the\nspecified range will be forwarded to the backends configured with this\nforwarding rule.\n\nThe portRange field has the following limitations:\n   \n   - It requires that the forwarding rule IPProtocol be TCP,\n   UDP, or SCTP, and\n   - It's applicable only to the following products: external passthrough\n   Network Load Balancers, internal and external proxy Network Load Balancers,\n   internal and external Application Load Balancers, external protocol\n   forwarding, and Classic VPN.\n   - Some products have restrictions on what ports can be used. See \n   port specifications for details.\n\n\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame [IPAddress, IPProtocol] pair, and cannot have overlappingportRanges.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same [IPAddress, IPProtocol]\npair, and cannot have overlapping portRanges.\n\n@pattern: \\\\d+(?:-\\\\d+)?",
"type": "string"
},
"ports": {
"description": "The ports, portRange, and allPorts\nfields are mutually exclusive. Only packets addressed to ports in the\nspecified range will be forwarded to the backends configured with this\nforwarding rule.\n\nThe ports field has the following limitations:\n   \n   - It requires that the forwarding rule IPProtocol be TCP,\n   UDP, or SCTP, and\n   - It's applicable only to the following products: internal passthrough\n   Network Load Balancers, backend service-based external passthrough Network\n   Load Balancers, and internal protocol forwarding.\n   - You can specify a list of up to five ports by number, separated by\n   commas. The ports can be contiguous or discontiguous.\n\n\n\nFor external forwarding rules, two or more forwarding rules cannot use the\nsame [IPAddress, IPProtocol] pair if they share at least one\nport number.\n\nFor internal forwarding rules within the same VPC network, two or more\nforwarding rules cannot use the same [IPAddress, IPProtocol]\npair if they share at least one port number.\n\n@pattern: \\\\d+(?:-\\\\d+)?",
"items": {
"type": "string"
},
"type": "array"
},
"pscConnectionId": {
"description": "[Output Only] The PSC connection id of the PSC forwarding rule.",
"format": "uint64",
"type": "string"
},
"pscConnectionStatus": {
"enum": [
"ACCEPTED",
"CLOSED",
"NEEDS_ATTENTION",
"PENDING",
"REJECTED",
"STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The connection has been accepted by the producer.",
"The connection has been closed by the producer and will not serve traffic\ngoing forward.",
"The connection has been accepted by the producer, but the producer needs\nto take further action before the forwarding rule can serve traffic.",
"The connection is pending acceptance by the producer.",
"The connection has been rejected by the producer.",
""
],
"readOnly": true,
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional forwarding rule resides.\nThis field is not applicable to global forwarding rules.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"serviceDirectoryRegistrations": {
"description": "Service Directory resources to register this forwarding rule with.\nCurrently, only supports a single Service Directory resource.",
"items": {
"$ref": "ForwardingRuleServiceDirectoryRegistration"
},
"type": "array"
},
"serviceLabel": {
"description": "An optional prefix to the service name for this forwarding rule.\nIf specified, the prefix is the first label of the fully qualified service\nname.\n\nThe label must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the label must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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]\nThe internal fully qualified service name for this forwarding rule.\n\nThis field is only used for internal load balancing.",
"type": "string"
},
"sourceIpRanges": {
"description": "If not empty, this forwarding rule will only forward the traffic when the\nsource IP address matches one of the IP addresses or CIDR ranges set here.\nNote that a forwarding rule can only have up to 64 source IP ranges, and\nthis field can only be used with a regional forwarding rule whose scheme isEXTERNAL.\nEach source_ip_range entry should be either an IP address (for\nexample, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24).",
"items": {
"type": "string"
},
"type": "array"
},
"subnetwork": {
"description": "This field identifies the subnetwork that the load balanced IP should\nbelong to for this forwarding rule, used with internal load balancers and\nexternal passthrough Network Load Balancers with IPv6.\n\nIf the network specified is in auto subnet mode, this field is optional.\nHowever, a subnetwork must be specified if the network is in custom subnet\nmode or when creating external forwarding rule with IPv6.",
"type": "string"
},
"target": {
"description": "The URL of the target resource to receive the matched traffic.  For\nregional forwarding rules, this target must be in the same region as the\nforwarding rule. For global forwarding rules, this target must be a global\nload balancing resource.\n\nThe forwarded traffic must be of a type appropriate to the target object.\n   \n   \n     -  For load balancers, see the \"Target\" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications).\n     -  For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle:\n       \n      \n            -  vpc-sc -  APIs that support VPC Service Controls. \n            -  all-apis - All supported Google APIs. \n          \n     \n     -  For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment.",
"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. [Output Only] Type of resource. Alwayscompute#forwardingRuleAggregatedList for lists of forwarding rules.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ForwardingRuleServiceDirectoryRegistration": {
"description": "Describes the auto-registration of the forwarding rule to Service Directory.\nThe region and project of the Service Directory resource generated from\nthis registration will be the same as this forwarding rule.",
"id": "ForwardingRuleServiceDirectoryRegistration",
"properties": {
"namespace": {
"description": "Service Directory namespace to register the forwarding rule under.",
"type": "string"
},
"service": {
"description": "Service Directory service to register the forwarding rule under.",
"type": "string"
},
"serviceDirectoryRegion": {
"description": "[Optional] Service Directory region to register this global forwarding\nrule under. Default to \"us-central1\". Only used for PSC for Google APIs.\nAll PSC for Google APIs forwarding rules on the same network should use\nthe same Service Directory region.",
"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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FutureReservation": {
"id": "FutureReservation",
"properties": {
"aggregateReservation": {
"$ref": "AllocationAggregateReservation",
"description": "Aggregate reservation details for the future reservation."
},
"autoCreatedReservationsDeleteTime": {
"description": "Future timestamp when the FR auto-created reservations will be deleted by\nCompute Engine. Format of this field must be a valid\nhref=\"https://www.ietf.org/rfc/rfc3339.txt\">RFC3339 value.",
"type": "string"
},
"autoCreatedReservationsDuration": {
"$ref": "Duration",
"description": "Specifies the duration of auto-created reservations.\nIt represents relative time to future reservation start_time when\nauto-created reservations will be automatically deleted by Compute\nEngine. Duration time unit is represented as a count of seconds\nand fractions of seconds at nanosecond resolution."
},
"autoDeleteAutoCreatedReservations": {
"description": "Setting for enabling or disabling automatic deletion for auto-created\nreservation. If set to true, auto-created reservations will be\ndeleted at Future Reservation's end time (default) or at user's defined\ntimestamp if any of the\n[auto_created_reservations_delete_time, auto_created_reservations_duration]\nvalues is specified.\nFor keeping auto-created reservation indefinitely, this value should be set\nto false.",
"type": "boolean"
},
"commitmentInfo": {
"$ref": "FutureReservationCommitmentInfo",
"description": "If not present, then FR will not deliver a new commitment or update an\nexisting commitment."
},
"confidentialComputeType": {
"enum": [
"CONFIDENTIAL_COMPUTE_TYPE_TDX",
"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Intel Trust Domain Extensions.",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp for this future reservation inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"deploymentType": {
"description": "Type of the deployment requested as part of future reservation.",
"enum": [
"DENSE",
"DEPLOYMENT_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"The reserved capacity is made up of densely deployed reservation blocks.",
""
],
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the future reservation.",
"type": "string"
},
"enableEmergentMaintenance": {
"description": "Indicates if this group of VMs have emergent maintenance enabled.",
"type": "boolean"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this future reservation. The server\ndefines this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#futureReservation",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"namePrefix": {
"description": "Name prefix for the reservations to be created at the time of\ndelivery. The name prefix must comply with RFC1035.\nMaximum allowed length for name prefix is 20. Automatically created\nreservations name format will be -date-####.",
"type": "string"
},
"params": {
"$ref": "FutureReservationParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"planningStatus": {
"description": "Planning state before being submitted for evaluation",
"enum": [
"DRAFT",
"PLANNING_STATUS_UNSPECIFIED",
"SUBMITTED"
],
"enumDescriptions": [
"Future Reservation is being drafted.",
"",
"Future Reservation has been submitted for evaluation by GCP."
],
"type": "string"
},
"reservationMode": {
"description": "The reservation mode which determines reservation-termination behavior and\nexpected pricing.",
"enum": [
"CALENDAR",
"DEFAULT",
"RESERVATION_MODE_UNSPECIFIED"
],
"enumDescriptions": [
"The delivered reservations will delivered at specified start time and\nterminated at specified end time along with terminating the VMs running\non it.",
"The delivered reservations do not terminate VMs at the end of\nreservations. This is default mode.",
""
],
"type": "string"
},
"reservationName": {
"description": "Name of reservations where the capacity is provisioned at the time of\ndelivery of  future reservations. If the reservation with the given name\ndoes not exist already, it is created automatically at the time of Approval\nwith INACTIVE state till specified start-time. Either provide the\nreservation_name or a name_prefix.",
"type": "string"
},
"schedulingType": {
"description": "Maintenance information for this reservation",
"enum": [
"GROUPED",
"GROUP_MAINTENANCE_TYPE_UNSPECIFIED",
"INDEPENDENT"
],
"enumDescriptions": [
"Maintenance on all reserved instances in the reservation is synchronized.",
"Unknown maintenance type.",
"Maintenance is not synchronized for this reservation. Instead, each\ninstance has its own maintenance window."
],
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"shareSettings": {
"$ref": "ShareSettings",
"description": "List of Projects/Folders to share with."
},
"specificReservationRequired": {
"description": "Indicates whether the auto-created reservation can be consumed by VMs with\naffinity for \"any\" reservation. If the field is set, then only VMs that\ntarget the reservation by name can consume from the delivered reservation.",
"type": "boolean"
},
"specificSkuProperties": {
"$ref": "FutureReservationSpecificSKUProperties",
"description": "Future Reservation configuration to indicate instance properties and\ntotal count."
},
"status": {
"$ref": "FutureReservationStatus",
"description": "Output only. [Output only] Status of the Future Reservation",
"readOnly": true
},
"timeWindow": {
"$ref": "FutureReservationTimeWindow",
"description": "Time window for this Future Reservation."
},
"zone": {
"description": "Output only. [Output Only] URL of the Zone where this future reservation resides.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"FutureReservationCommitmentInfo": {
"id": "FutureReservationCommitmentInfo",
"properties": {
"commitmentName": {
"description": "name of the commitment where capacity is being delivered to.",
"type": "string"
},
"commitmentPlan": {
"description": "Indicates if a Commitment needs to be created as part of FR delivery. If\nthis field is not present, then no\ncommitment needs to be created.",
"enum": [
"INVALID",
"THIRTY_SIX_MONTH",
"TWELVE_MONTH"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"previousCommitmentTerms": {
"description": "Only applicable if FR is delivering to the same reservation. If set, all\nparent commitments will be extended to match the end date of the plan for\nthis commitment.",
"enum": [
"EXTEND",
"PREVIOUSCOMMITMENTTERM_UNSPECIFIED"
],
"enumDescriptions": [
"All associated parent Committed Used Discount(s) end-date/term will be\nextended to the end-time of this future reservation. Default is to\nextend previous commitment(s) time to the end_time of the reservation.",
"No changes to associated parents Committed Used Discount(s) terms."
],
"type": "string"
}
},
"type": "object"
},
"FutureReservationParams": {
"description": "Additional future reservation params.",
"id": "FutureReservationParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the future reservation. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"FutureReservationSpecificSKUProperties": {
"id": "FutureReservationSpecificSKUProperties",
"properties": {
"instanceProperties": {
"$ref": "AllocationSpecificSKUAllocationReservedInstanceProperties",
"description": "Properties of the SKU instances being reserved."
},
"sourceInstanceTemplate": {
"description": "The instance template that will be used to populate the\nReservedInstanceProperties of the future reservation",
"type": "string"
},
"totalCount": {
"description": "Total number of instances for which capacity assurance is requested at a\nfuture time period.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"FutureReservationStatus": {
"description": "[Output only] Represents status related to the future reservation.",
"id": "FutureReservationStatus",
"properties": {
"amendmentStatus": {
"description": "Output only. [Output Only] The current status of the requested amendment.",
"enum": [
"AMENDMENT_APPROVED",
"AMENDMENT_DECLINED",
"AMENDMENT_IN_REVIEW",
"AMENDMENT_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The requested amendment to the Future Resevation has been approved and\napplied by GCP.",
"The requested amendment to the Future Reservation has been declined by\nGCP and the original state was restored.",
"The requested amendment to the Future Reservation is currently being\nreviewd by GCP.",
""
],
"readOnly": true,
"type": "string"
},
"autoCreatedReservations": {
"description": "Output only. Fully qualified urls of the automatically created reservations at\nstart_time.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"existingMatchingUsageInfo": {
"$ref": "FutureReservationStatusExistingMatchingUsageInfo",
"description": "Output only. [Output Only] Represents the existing matching usage for the future\nreservation.",
"readOnly": true
},
"fulfilledCount": {
"description": "Output only. This count indicates the fulfilled capacity so far. This is set during\n\"PROVISIONING\" state. This count also includes capacity delivered as part\nof existing matching reservations.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"lastKnownGoodState": {
"$ref": "FutureReservationStatusLastKnownGoodState",
"description": "Output only. [Output Only] This field represents the future reservation before an\namendment was requested. If the amendment is declined, the Future\nReservation will be reverted to the last known good state. The last known\ngood state is not set when updating a future reservation whose\nProcurement Status is DRAFTING.",
"readOnly": true
},
"lockTime": {
"description": "Output only. Time when Future Reservation would become LOCKED, after which no\nmodifications to Future Reservation will be allowed. Applicable only\nafter the Future Reservation is in the APPROVED state. The lock_time is\nan RFC3339 string. The procurement_status will transition to PROCURING\nstate at this time.",
"readOnly": true,
"type": "string"
},
"procurementStatus": {
"description": "Output only. Current state of this Future Reservation",
"enum": [
"APPROVED",
"CANCELLED",
"COMMITTED",
"DECLINED",
"DRAFTING",
"FAILED",
"FAILED_PARTIALLY_FULFILLED",
"FULFILLED",
"PENDING_AMENDMENT_APPROVAL",
"PENDING_APPROVAL",
"PROCUREMENT_STATUS_UNSPECIFIED",
"PROCURING",
"PROVISIONING"
],
"enumDescriptions": [
"Future reservation is approved by GCP.",
"Future reservation is cancelled by the customer.",
"Future reservation is committed by the customer.",
"Future reservation is rejected by GCP.",
"Related status for PlanningStatus.Draft. Transitions to\nPENDING_APPROVAL upon user submitting FR.",
"Future reservation failed. No additional reservations were provided.",
"Future reservation is partially fulfilled. Additional reservations were\nprovided but did not reach total_count reserved instance slots.",
"Future reservation is fulfilled completely.",
"An Amendment to the Future Reservation has been requested. If the\nAmendment is declined, the Future Reservation will be restored to the\nlast known good state.",
"Future reservation is pending approval by GCP.",
"",
"Future reservation is being procured by GCP. Beyond this point, Future\nreservation is locked and no further modifications are allowed.",
"Future reservation capacity is being provisioned. This state will be\nentered after start_time, while reservations are being created to\nprovide total_count reserved instance slots. This state will not\npersist past start_time + 24h."
],
"readOnly": true,
"type": "string"
},
"specificSkuProperties": {
"$ref": "FutureReservationStatusSpecificSKUProperties"
}
},
"type": "object"
},
"FutureReservationStatusExistingMatchingUsageInfo": {
"description": "[Output Only] Represents the existing matching usage for the future\nreservation.",
"id": "FutureReservationStatusExistingMatchingUsageInfo",
"properties": {
"count": {
"description": "Output only. Count to represent min(FR total_count,\nmatching_reserved_capacity+matching_unreserved_instances)",
"format": "int64",
"readOnly": true,
"type": "string"
},
"timestamp": {
"description": "Output only. Timestamp when the matching usage was calculated",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"FutureReservationStatusLastKnownGoodState": {
"description": "The state that the future reservation will be reverted to should the\namendment be declined.",
"id": "FutureReservationStatusLastKnownGoodState",
"properties": {
"description": {
"description": "Output only. [Output Only] The description of the FutureReservation before an\namendment was requested.",
"readOnly": true,
"type": "string"
},
"existingMatchingUsageInfo": {
"$ref": "FutureReservationStatusExistingMatchingUsageInfo",
"description": "Output only. [Output Only] Represents the matching usage for the future\nreservation before an amendment was requested.",
"readOnly": true
},
"futureReservationSpecs": {
"$ref": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs",
"readOnly": true
},
"lockTime": {
"description": "Output only. [Output Only] The lock time of the FutureReservation before an\namendment was requested.",
"readOnly": true,
"type": "string"
},
"namePrefix": {
"description": "Output only. [Output Only] The name prefix of the Future Reservation before an\namendment was requested.",
"readOnly": true,
"type": "string"
},
"procurementStatus": {
"description": "Output only. [Output Only] The status of the last known good state for the Future\nReservation.",
"enum": [
"APPROVED",
"CANCELLED",
"COMMITTED",
"DECLINED",
"DRAFTING",
"FAILED",
"FAILED_PARTIALLY_FULFILLED",
"FULFILLED",
"PENDING_AMENDMENT_APPROVAL",
"PENDING_APPROVAL",
"PROCUREMENT_STATUS_UNSPECIFIED",
"PROCURING",
"PROVISIONING"
],
"enumDescriptions": [
"Future reservation is approved by GCP.",
"Future reservation is cancelled by the customer.",
"Future reservation is committed by the customer.",
"Future reservation is rejected by GCP.",
"Related status for PlanningStatus.Draft. Transitions to\nPENDING_APPROVAL upon user submitting FR.",
"Future reservation failed. No additional reservations were provided.",
"Future reservation is partially fulfilled. Additional reservations were\nprovided but did not reach total_count reserved instance slots.",
"Future reservation is fulfilled completely.",
"An Amendment to the Future Reservation has been requested. If the\nAmendment is declined, the Future Reservation will be restored to the\nlast known good state.",
"Future reservation is pending approval by GCP.",
"",
"Future reservation is being procured by GCP. Beyond this point, Future\nreservation is locked and no further modifications are allowed.",
"Future reservation capacity is being provisioned. This state will be\nentered after start_time, while reservations are being created to\nprovide total_count reserved instance slots. This state will not\npersist past start_time + 24h."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"FutureReservationStatusLastKnownGoodStateFutureReservationSpecs": {
"description": "The properties of the last known good state for the Future Reservation.",
"id": "FutureReservationStatusLastKnownGoodStateFutureReservationSpecs",
"properties": {
"shareSettings": {
"$ref": "ShareSettings",
"description": "Output only. [Output Only] The previous share settings of the Future Reservation.",
"readOnly": true
},
"specificSkuProperties": {
"$ref": "FutureReservationSpecificSKUProperties",
"description": "Output only. [Output Only] The previous instance related properties of the\nFuture Reservation.",
"readOnly": true
},
"timeWindow": {
"$ref": "FutureReservationTimeWindow",
"description": "Output only. [Output Only] The previous time window of the Future Reservation.",
"readOnly": true
}
},
"type": "object"
},
"FutureReservationStatusSpecificSKUProperties": {
"description": "Properties to be set for the Future Reservation.",
"id": "FutureReservationStatusSpecificSKUProperties",
"properties": {
"sourceInstanceTemplateId": {
"description": "ID of the instance template used to populate the Future Reservation\nproperties.",
"type": "string"
}
},
"type": "object"
},
"FutureReservationTimeWindow": {
"id": "FutureReservationTimeWindow",
"properties": {
"duration": {
"$ref": "Duration"
},
"endTime": {
"type": "string"
},
"startTime": {
"description": "Start time of the Future Reservation. The start_time is an RFC3339\nstring.",
"type": "string"
}
},
"type": "object"
},
"FutureReservationsAggregatedListResponse": {
"description": "Contains a list of future reservations.",
"id": "FutureReservationsAggregatedListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "FutureReservationsScopedList",
"description": "Name of the scope containing this set of future reservations."
},
"description": "A list of Future reservation resources.",
"type": "object"
},
"kind": {
"default": "compute#futureReservationsAggregatedListResponse",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#futureReservationsAggregatedListResponse for future\nresevation aggregated list response.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FutureReservationsListResponse": {
"id": "FutureReservationsListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"type": "string"
},
"items": {
"description": "[Output Only] A list of future reservation resources.",
"items": {
"$ref": "FutureReservation"
},
"type": "array"
},
"kind": {
"default": "compute#futureReservationsListResponse",
"description": "Output only. [Output Only] Type of resource.Alwayscompute#FutureReservationsListResponse for lists of\nreservations",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FutureReservationsScopedList": {
"id": "FutureReservationsScopedList",
"properties": {
"futureReservations": {
"description": "A list of future reservations contained in this scope.",
"items": {
"$ref": "FutureReservation"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of future reservations when\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"FutureResourcesRecommendation": {
"description": "Recommendation for single resources specification, to be created in the\nfuture.",
"id": "FutureResourcesRecommendation",
"properties": {
"endTime": {
"format": "google-datetime",
"type": "string"
},
"location": {
"description": "The advised location for resource usage. When a zone, in format\n'zones/'.\nIf not set, it means that no location is recommended - see\nother_locations for details.",
"type": "string"
},
"otherLocations": {
"additionalProperties": {
"$ref": "FutureResourcesRecommendationOtherLocation"
},
"description": "List of locations in the request scope that were not\nrecommended. Keys of the map are zones, in format 'zones/'.\nThe values are status information indicating the recommendation status.",
"type": "object"
},
"recommendationId": {
"description": "Unique id of the recommendation, a UUID string generated by the API.",
"type": "string"
},
"recommendationType": {
"description": "Type of recommendation. Currently only FUTURE_RESERVATION is supported.",
"enum": [
"FUTURE_RESERVATION",
"RECOMMENDATION_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"A Future Reservation is recommended.",
"Default value, unused."
],
"type": "string"
},
"startTime": {
"format": "google-datetime",
"type": "string"
}
},
"type": "object"
},
"FutureResourcesRecommendationOtherLocation": {
"description": "Information about recommendation status for locations\nthat were allowed but not used by the response.",
"id": "FutureResourcesRecommendationOtherLocation",
"properties": {
"details": {
"description": "Details (human readable) describing the situation.\nFor example, if status is CONDITION_NOT_MET, then\ndetails contain information about the parameters of the time window\nthat did not meet the required conditions.",
"type": "string"
},
"status": {
"description": "Status of recommendation in this location.",
"enum": [
"CONDITIONS_NOT_MET",
"NOT_SUPPORTED",
"NO_CAPACITY",
"OTHER_LOCATION_STATUS_UNDEFINED",
"RECOMMENDED"
],
"enumDescriptions": [
"The requested resources are offered in this location\nbut the requested time window is does not meet the required conditions.",
"The requested resources are not offered in this location.\nRetrying the request will not change this status.",
"The requested resources are offered in this location\nand the requested time window is accepted\nbut there is no capacity within the requested time window.",
"Default value, unused.",
"The requested resources are offered in this location\nand it is possible to request them. However, another location\nwas better and was recommended."
],
"type": "string"
}
},
"type": "object"
},
"FutureResourcesSpec": {
"description": "Specification of resources to be created at some time in the future within an\noptionally specified set of locations, and within the specified time range.",
"id": "FutureResourcesSpec",
"properties": {
"deploymentType": {
"description": "Indicates if the reservation allocation strategy is static (DENSE) or\ndynamic (STANDARD). Defaults to DENSE.",
"enum": [
"DENSE",
"DEPLOYMENT_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"The reserved capacity is made up of densely deployed reservation blocks.",
""
],
"type": "string"
},
"locationPolicy": {
"$ref": "FutureResourcesSpecLocationPolicy",
"description": "Optional location policy allowing to exclude some zone(s) in which\nthe resources must not be created."
},
"targetResources": {
"$ref": "FutureResourcesSpecTargetResources",
"description": "Specification of the reserved resources."
},
"timeRangeSpec": {
"$ref": "FlexibleTimeRange",
"description": "Specification of a time range in which the resources may be created.\nThe time range specifies start of resource use and planned end of resource\nuse."
}
},
"type": "object"
},
"FutureResourcesSpecAggregateResources": {
"id": "FutureResourcesSpecAggregateResources",
"properties": {
"acceleratorCount": {
"description": "Size of the request, in accelerator (chip) count.",
"format": "int64",
"type": "string"
},
"vmFamily": {
"description": "The VM family that all instances scheduled against this reservation\nmust belong to. Use for TPU reservations.",
"enum": [
"VM_FAMILY_CLOUD_TPU_DEVICE_CT3",
"VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L",
"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP",
"VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P",
"VM_FAMILY_CLOUD_TPU_POD_SLICE_TPU7X"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"workloadType": {
"description": "Workload type. Use for TPU reservations.",
"enum": [
"BATCH",
"SERVING",
"UNSPECIFIED"
],
"enumDescriptions": [
"Reserved resources will be optimized for BATCH workloads, such as ML\ntraining.",
"Reserved resources will be optimized for SERVING workloads, such as ML\ninference.",
""
],
"type": "string"
}
},
"type": "object"
},
"FutureResourcesSpecLocalSsdPartition": {
"id": "FutureResourcesSpecLocalSsdPartition",
"properties": {
"diskInterface": {
"description": "Disk interface. Defaults to SCSI.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"diskSizeGb": {
"description": "The size of the disk in GB.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"FutureResourcesSpecLocationPolicy": {
"description": "Specification of locations to create resources in.",
"id": "FutureResourcesSpecLocationPolicy",
"properties": {
"locations": {
"additionalProperties": {
"$ref": "FutureResourcesSpecLocationPolicyLocation"
},
"description": "Preferences for specified locations.\nKeys of the map are locations - zones, in format of 'zones/'.\nValues are preferences for the zones.\nIf a zone is not specified in this map, it is ALLOWed.",
"type": "object"
}
},
"type": "object"
},
"FutureResourcesSpecLocationPolicyLocation": {
"description": "Preference for a single specified location.",
"id": "FutureResourcesSpecLocationPolicyLocation",
"properties": {
"preference": {
"description": "Preference for this location.",
"enum": [
"ALLOW",
"DENY",
"PREFERENCE_UNSPECIFIED"
],
"enumDescriptions": [
"Location is allowed for use.",
"Location is prohibited.",
"Default value, unused."
],
"type": "string"
}
},
"type": "object"
},
"FutureResourcesSpecSpecificSKUResources": {
"id": "FutureResourcesSpecSpecificSKUResources",
"properties": {
"instanceCount": {
"description": "Size of the request, in instance count.",
"format": "int64",
"type": "string"
},
"localSsdPartitions": {
"description": "Local SSD partitions. You do not have to include SSD partitions that\nare built in the machine type.",
"items": {
"$ref": "FutureResourcesSpecLocalSsdPartition"
},
"type": "array"
},
"machineType": {
"description": "The machine type to use for instances that will use the reservation.\nThis field only accepts machine type names. e.g. n2-standard-4\nand does not accept machine type full or partial url. e.g.\nprojects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4.\nUse for GPU reservations.",
"type": "string"
}
},
"type": "object"
},
"FutureResourcesSpecTargetResources": {
"description": "Specification of reserved resources.",
"id": "FutureResourcesSpecTargetResources",
"properties": {
"aggregateResources": {
"$ref": "FutureResourcesSpecAggregateResources"
},
"specificSkuResources": {
"$ref": "FutureResourcesSpecSpecificSKUResources"
}
},
"type": "object"
},
"GRPCHealthCheck": {
"id": "GRPCHealthCheck",
"properties": {
"grpcServiceName": {
"description": "The gRPC service name for the health check. This field is optional. The\nvalue of grpc_service_name has the following meanings by convention: \n\n- Empty service_name means the overall status of all services at the\nbackend. \n\n- Non-empty service_name means the health of that gRPC service, as defined\nby the owner of the service. \n\nThe grpc_service_name can only be ASCII.",
"type": "string"
},
"port": {
"description": "The TCP port number to which the health check prober sends packets. Valid\nvalues are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
}
},
"type": "object"
},
"GRPCTLSHealthCheck": {
"id": "GRPCTLSHealthCheck",
"properties": {
"grpcServiceName": {
"description": "The gRPC service name for the health check. This field is optional. The\nvalue of grpc_service_name has the following meanings by convention: \n\n- Empty service_name means the overall status of all services at the\nbackend. \n\n- Non-empty service_name means the health of that gRPC service, as defined\nby the owner of the service. \n\nThe grpc_service_name can only be ASCII.",
"type": "string"
},
"port": {
"description": "The TCP port number to which the health check prober sends packets. Valid\nvalues are 1 through 65535.",
"format": "int32",
"type": "integer"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
}
},
"type": "object"
},
"GetVersionOperationMetadata": {
"id": "GetVersionOperationMetadata",
"properties": {
"inlineSbomInfo": {
"$ref": "GetVersionOperationMetadataSbomInfo"
}
},
"type": "object"
},
"GetVersionOperationMetadataSbomInfo": {
"id": "GetVersionOperationMetadataSbomInfo",
"properties": {
"currentComponentVersions": {
"additionalProperties": {
"type": "string"
},
"description": "A mapping of components to their currently-applied versions or other\nappropriate identifiers.",
"type": "object"
},
"targetComponentVersions": {
"additionalProperties": {
"type": "string"
},
"description": "A mapping of components to their target versions or other appropriate\nidentifiers.",
"type": "object"
}
},
"type": "object"
},
"GlobalAddressesMoveRequest": {
"id": "GlobalAddressesMoveRequest",
"properties": {
"description": {
"description": "An optional destination address description if intended to be different\nfrom the source.",
"type": "string"
},
"destinationAddress": {
"description": "The URL of the destination address to move to. This can be a full or\npartial URL. For example, the following are all valid URLs to a address:\n   \n   - https://www.googleapis.com/compute/v1/projects/project/global/addresses/address \n   - projects/project/global/addresses/address\n\n\nNote that destination project must be different from the source project. So/global/addresses/address is not valid partial url.",
"type": "string"
}
},
"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"
},
"GlobalOrganizationSetPolicyRequest": {
"id": "GlobalOrganizationSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. 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\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"GlobalSetLabelsRequest": {
"id": "GlobalSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You must\nalways provide an up-to-date fingerprint hash when updating or changing\nlabels, otherwise the request will fail with error412 conditionNotMet.  Make a get() request to the\nresource 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 must comply with\nthe\nrequirements for labels. For example,\"webserver-frontend\": \"images\". A label value can also be\nempty (e.g. \"my-label\": \"\").",
"type": "object"
}
},
"type": "object"
},
"GlobalSetPolicyRequest": {
"id": "GlobalSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. 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\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"GlobalVmExtensionPolicy": {
"description": "Message describing GlobalVmExtensionPolicy object.",
"id": "GlobalVmExtensionPolicy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"extensionPolicies": {
"additionalProperties": {
"$ref": "GlobalVmExtensionPolicyExtensionPolicy"
},
"description": "Required. Map from extension (eg: \"cloudops\") to its policy configuration.\nThe key is the name of the extension.",
"type": "object"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceSelectors": {
"description": "Optional. Selector to target VMs for a policy.\nThere is a logical \"AND\" between instance_selectors.",
"items": {
"$ref": "GlobalVmExtensionPolicyInstanceSelector"
},
"type": "array"
},
"kind": {
"default": "compute#globalVmExtensionPolicy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#globalVmExtensionPolicy for globalVmExtensionPolicies.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"priority": {
"description": "Optional. Used to resolve conflicts when multiple policies are active for the same\nextension. Defaults to 0.\n\nLarger the number, higher the priority. When the priority is the same,\nthe policy with the newer create time has higher priority.",
"format": "int32",
"type": "integer"
},
"rolloutOperation": {
"$ref": "GlobalVmExtensionPolicyRolloutOperation",
"description": "Required. The rollout strategy and status."
},
"scopedResourceStatus": {
"description": "Output only. [Output Only] The scoped resource status. It's only for tracking the\npurging status of the policy.",
"enum": [
"SCOPED_RESOURCE_STATUS_DELETING",
"SCOPED_RESOURCE_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The zonal policies are being deleted.",
"Default value. This value is unused."
],
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"updateTimestamp": {
"description": "Output only. [Output Only] Update timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GlobalVmExtensionPolicyExtensionPolicy": {
"description": "Policy for a single extension.",
"id": "GlobalVmExtensionPolicyExtensionPolicy",
"properties": {
"pinnedVersion": {
"description": "Optional. The version pinning for the extension.\nIf empty, the extension will be installed with the latest version\nreleased by the extension producer.",
"type": "string"
},
"stringConfig": {
"description": "Optional. String configuration. Any string payload that the extension\nunderstands.",
"type": "string"
}
},
"type": "object"
},
"GlobalVmExtensionPolicyInstanceSelector": {
"description": "Selector to target VMs for a zone VM extension policy.",
"id": "GlobalVmExtensionPolicyInstanceSelector",
"properties": {
"labelSelector": {
"$ref": "GlobalVmExtensionPolicyLabelSelector",
"description": "Optional. Labels within the LabelSelector are OR'd."
}
},
"type": "object"
},
"GlobalVmExtensionPolicyLabelSelector": {
"description": "A LabelSelector is applicable for a VM only if it matches all labels in\nthe LabelSelector.",
"id": "GlobalVmExtensionPolicyLabelSelector",
"properties": {
"inclusionLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Labels as key value pairs.\nA VM should contain all the pairs specified in this map to be selected;\nLabels within the LabelSelector are OR'ed.",
"type": "object"
}
},
"type": "object"
},
"GlobalVmExtensionPolicyList": {
"description": "Response to list global VM extension policy resources.",
"id": "GlobalVmExtensionPolicyList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of GlobalVmExtensionPolicy resources.",
"items": {
"$ref": "GlobalVmExtensionPolicy"
},
"type": "array"
},
"kind": {
"default": "compute#globalVmExtensionPolicyList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"GlobalVmExtensionPolicyRolloutOperation": {
"description": "Represents the rollout operation",
"id": "GlobalVmExtensionPolicyRolloutOperation",
"properties": {
"rolloutInput": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutInput",
"description": "Required. The rollout input which defines the rollout plan."
},
"rolloutStatus": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus",
"description": "Output only. [Output Only] The rollout status of the policy.",
"readOnly": true
}
},
"type": "object"
},
"GlobalVmExtensionPolicyRolloutOperationRolloutInput": {
"id": "GlobalVmExtensionPolicyRolloutOperationRolloutInput",
"properties": {
"conflictBehavior": {
"description": "Optional. Specifies the behavior of the rollout if a conflict is detected in a\nproject during a rollout. This only applies to `insert` and `update`\nmethods.\n\nA conflict occurs in the following cases:\n\n* `insert` method: If the zonal policy already exists when the insert\n  happens.\n* `update` method: If the zonal policy was modified by a zonal API call\n  outside of this rollout.\n\nPossible values are the following:\n\n* `\"\"` (empty string): If a conflict occurs, the local value is not\n  overwritten. This is the default behavior.\n* `\"overwrite\"`: If a conflict occurs, the local value is overwritten\n  with the rollout value.",
"type": "string"
},
"name": {
"description": "Optional. The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.",
"type": "string"
},
"predefinedRolloutPlan": {
"description": "Optional. Specifies the predefined rollout plan for the policy. Valid values\nare `SLOW_ROLLOUT` and `FAST_ROLLOUT`. The recommended value is\n`SLOW_ROLLOUT` for progressive rollout. For more information, see Rollout\nplans for global policies.",
"enum": [
"FAST_ROLLOUT",
"ROLLOUT_PLAN_UNSPECIFIED",
"SLOW_ROLLOUT"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"retryUuid": {
"description": "Optional. The UUID that identifies a policy rollout retry attempt for update and\ndelete operations. Set this field only when retrying a rollout for an\nexisting extension policy.\n\n* `update` method: Lets you retry policy rollout without changes.\nAn error occurs if you set retry_uuid but the policy is modified.\n* `delete` method: Lets you retry policy deletion rollout if the\nprevious deletion rollout is not finished and the policy is in the\nDELETING state. If you set this field when the policy is not in the\nDELETING state, an error occurs.",
"type": "string"
}
},
"type": "object"
},
"GlobalVmExtensionPolicyRolloutOperationRolloutStatus": {
"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatus",
"properties": {
"currentRollouts": {
"description": "Output only. [Output Only] The current rollouts for the latest version of the\nresource. There should be only one current rollout, but for\nscalability, we make it repeated.",
"items": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata"
},
"readOnly": true,
"type": "array"
},
"previousRollout": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata",
"description": "Output only. [Output Only] The last completed rollout resource. This field will not\nbe populated until the first rollout is completed.",
"readOnly": true
}
},
"type": "object"
},
"GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata": {
"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadata",
"properties": {
"locationRolloutStatus": {
"additionalProperties": {
"$ref": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus"
},
"description": "Output only. [Output Only] The rollout status for each location. The list of the\nlocations is the same as the list of locations in the rollout plan.",
"readOnly": true,
"type": "object"
},
"rollout": {
"description": "Output only. [Output Only] The name of the rollout.\nEx. projects//locations/global/rollouts/.",
"readOnly": true,
"type": "string"
},
"rolloutPlan": {
"description": "Output only. [Output Only] The name of the rollout plan.\nEx.\nprojects//locations/global/rolloutPlans/.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. [Output Only] The overall state of the rollout.",
"enum": [
"STATE_CANCELLED",
"STATE_COMPLETED",
"STATE_FAILED",
"STATE_PAUSED",
"STATE_PROCESSING",
"STATE_UNKNOWN",
"STATE_UNSPECIFIED"
],
"enumDescriptions": [
"Iteration was explicitly cancelled.",
"Iteration completed, with all actions being successful.",
"Iteration completed, with failures.",
"The rollout is paused.",
"Iteration is in progress.",
"Impossible to determine current state of the iteration.",
"Default value. This value is unused."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus": {
"id": "GlobalVmExtensionPolicyRolloutOperationRolloutStatusRolloutMetadataLocationRolloutStatus",
"properties": {
"state": {
"description": "Output only. [Output Only] The state of the location rollout.",
"enum": [
"LOCATION_ROLLOUT_STATE_COMPLETED",
"LOCATION_ROLLOUT_STATE_FAILED",
"LOCATION_ROLLOUT_STATE_NOT_STARTED",
"LOCATION_ROLLOUT_STATE_SKIPPED",
"LOCATION_ROLLOUT_STATE_UNSPECIFIED"
],
"enumDescriptions": [
"The location rollout is completed.",
"The location rollout has failed.",
"The location rollout has not started.",
"The location rollout is skipped.",
"Default value. This value is unused."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GroupMaintenanceInfo": {
"description": "Maintenance Info for ReservationBlocks.",
"id": "GroupMaintenanceInfo",
"properties": {
"instanceMaintenanceOngoingCount": {
"description": "Describes number of instances that have ongoing maintenance.",
"format": "int32",
"type": "integer"
},
"instanceMaintenancePendingCount": {
"description": "Describes number of instances that have pending maintenance.",
"format": "int32",
"type": "integer"
},
"maintenanceOngoingCount": {
"description": "Progress for ongoing maintenance for this group of VMs/hosts.\nDescribes number of hosts in the block that have ongoing maintenance.",
"format": "int32",
"type": "integer"
},
"maintenancePendingCount": {
"description": "Progress for ongoing maintenance for this group of VMs/hosts.\nDescribes number of hosts in the block that have pending maintenance.",
"format": "int32",
"type": "integer"
},
"schedulingType": {
"description": "The type of maintenance for the reservation.",
"enum": [
"GROUPED",
"GROUP_MAINTENANCE_TYPE_UNSPECIFIED",
"INDEPENDENT"
],
"enumDescriptions": [
"Maintenance on all reserved instances in the reservation is synchronized.",
"Unknown maintenance type.",
"Maintenance is not synchronized for this reservation. Instead, each\ninstance has its own maintenance window."
],
"type": "string"
},
"subblockInfraMaintenanceOngoingCount": {
"description": "Describes number of subblock Infrastructure that has ongoing maintenance.\nHere, Subblock Infrastructure Maintenance pertains to upstream hardware\ncontained in the Subblock that is necessary for a VM Family(e.g. NVLink\nDomains). Not all VM Families will support this field.",
"format": "int32",
"type": "integer"
},
"subblockInfraMaintenancePendingCount": {
"description": "Describes number of subblock Infrastructure that has pending maintenance.\n Here, Subblock Infrastructure Maintenance pertains to upstream hardware\n contained in the Subblock that is necessary for a VM Family (e.g. NVLink\n Domains). Not all VM Families will support this field.",
"format": "int32",
"type": "integer"
},
"upcomingGroupMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Maintenance information on this group of VMs."
}
},
"type": "object"
},
"GuestAttributes": {
"description": "A guest attributes entry.",
"id": "GuestAttributes",
"properties": {
"kind": {
"default": "compute#guestAttributes",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#guestAttributes for guest attributes entry.",
"readOnly": true,
"type": "string"
},
"queryPath": {
"description": "The path to be queried. This can be the default namespace ('') or a\nnested namespace ('\\/') or a specified key\n('\\/\\').",
"type": "string"
},
"queryValue": {
"$ref": "GuestAttributesValue",
"description": "Output only. [Output Only] The value of the requested queried path.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"variableKey": {
"description": "The key to search for.",
"type": "string"
},
"variableValue": {
"description": "Output only. [Output Only] The value found for the requested key.",
"readOnly": true,
"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. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n   \n   - VIRTIO_SCSI_MULTIQUEUE\n   - WINDOWS\n   - MULTI_IP_SUBNET\n   - UEFI_COMPATIBLE\n   - GVNIC\n   - SEV_CAPABLE\n   - SUSPEND_RESUME_COMPATIBLE\n   - SEV_LIVE_MIGRATABLE_V2\n   - SEV_SNP_CAPABLE\n   - TDX_CAPABLE\n   - IDPF\n   - SNP_SVSM_CAPABLE\n   - CCA_CAPABLE\n\n\nFor more information, see\nEnabling guest operating system features.",
"enum": [
"BARE_METAL_LINUX_COMPATIBLE",
"FEATURE_TYPE_UNSPECIFIED",
"GVNIC",
"IDPF",
"MULTI_IP_SUBNET",
"SECURE_BOOT",
"SEV_CAPABLE",
"SEV_LIVE_MIGRATABLE",
"SEV_LIVE_MIGRATABLE_V2",
"SEV_SNP_CAPABLE",
"SNP_SVSM_CAPABLE",
"TDX_CAPABLE",
"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\nempty (default value), the host header is set to the destination IP address\nto which health check packets are sent. The destination IP address depends\non the type of load balancer. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
"type": "string"
},
"port": {
"description": "The TCP port number to which the health check prober sends packets. The\ndefault value is 443. Valid values are 1 through65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTP/2 health check request. The default value is/. Must comply withRFC3986.",
"type": "string"
},
"response": {
"description": "Creates a content-based HTTP/2 health check. In addition to the required\nHTTP 200 (OK) status code, you can configure the health check to pass only\nwhen the backend sends this specific ASCII response string within the first\n1024 bytes of the HTTP response body. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
"type": "string"
}
},
"type": "object"
},
"HTTPHealthCheck": {
"id": "HTTPHealthCheck",
"properties": {
"host": {
"description": "The value of the host header in the HTTP health check request. If left\nempty (default value), the host header is set to the destination IP address\nto which health check packets are sent. The destination IP address depends\non the type of load balancer. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
"type": "string"
},
"port": {
"description": "The TCP port number to which the health check prober sends packets. The\ndefault value is 80. Valid values are 1 through65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Also supported in legacy HTTP health checks for target pools.\nThe health check supports all backends supported by the backend service\nprovided the backend can be health checked. For example,GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT\nnetwork endpoint groups, and instance group backends. \nUSE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for pass-through load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTP health check request. The default value is/. Must comply withRFC3986.",
"type": "string"
},
"response": {
"description": "Creates a content-based HTTP health check. In addition to the required\nHTTP 200 (OK) status code, you can configure the health check to pass only\nwhen the backend sends this specific ASCII response string within the first\n1024 bytes of the HTTP response body. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
"type": "string"
}
},
"type": "object"
},
"HTTPSHealthCheck": {
"id": "HTTPSHealthCheck",
"properties": {
"host": {
"description": "The value of the host header in the HTTPS health check request. If left\nempty (default value), the host header is set to the destination IP address\nto which health check packets are sent. The destination IP address depends\non the type of load balancer. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest",
"type": "string"
},
"port": {
"description": "The TCP port number to which the health check prober sends packets. The\ndefault value is 443. Valid values are 1 through65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestPath": {
"description": "The request path of the HTTPS health check request. The default value is/. Must comply withRFC3986.",
"type": "string"
},
"response": {
"description": "Creates a content-based HTTPS health check. In addition to the required\nHTTP 200 (OK) status code, you can configure the health check to pass only\nwhen the backend sends this specific ASCII response string within the first\n1024 bytes of the HTTP response body. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http",
"type": "string"
}
},
"type": "object"
},
"HealthAggregationPoliciesScopedList": {
"id": "HealthAggregationPoliciesScopedList",
"properties": {
"healthAggregationPolicies": {
"description": "A list of HealthAggregationPolicys contained in this scope.",
"items": {
"$ref": "HealthAggregationPolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of health aggregation\npolicies when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthAggregationPolicy": {
"description": "Represents a health aggregation policy.\n\nA health aggregation policy resource defines a policy to aggregate health.\n\nFor more information, see\nHealth checks overview.",
"id": "HealthAggregationPolicy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthAggregationPolicy. An up-to-date fingerprint\nmust be provided in order to patch the HealthAggregationPolicy; Otherwise,\nthe request will fail with error 412 conditionNotMet. To see\nthe latest fingerprint, make a get() request to retrieve the\nHealthAggregationPolicy.",
"format": "byte",
"type": "string"
},
"healthyPercentThreshold": {
"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the threshold (as a\npercentage) of healthy endpoints required in order to consider the\naggregated health result HEALTHY. Defaults to 60. Must be in\nrange [0, 100]. Not applicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and minHealthyThreshold must be satisfied in order\nfor HEALTHY to be the aggregated result. \"Endpoints\" refers to network\nendpoints within a Network Endpoint Group or instances within an Instance\nGroup.",
"format": "uint32",
"type": "integer"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#healthAggregationPolicy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.",
"readOnly": true,
"type": "string"
},
"minHealthyThreshold": {
"description": "Can only be set if the policyType field isBACKEND_SERVICE_POLICY. Specifies the minimum number of\nhealthy endpoints required in order to consider the aggregated health\nresult HEALTHY. Defaults to 1. Must be positive. Not\napplicable if the policyType field isDNB_PUBLIC_IP_POLICY. Can be mutated. This field is optional,\nand will be set to the default if unspecified. Note that both this\nthreshold and healthyPercentThreshold must be satisfied in\norder for HEALTHY to be the aggregated result. \"Endpoints\" refers to\nnetwork endpoints within a Network Endpoint Group or instances within an\nInstance Group.",
"format": "uint32",
"type": "integer"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"policyType": {
"description": "Specifies the type of the healthAggregationPolicy. The only allowed value\nfor global resources is DNS_PUBLIC_IP_POLICY. The only allowed\nvalue for regional resources is BACKEND_SERVICE_POLICY. Must\nbe specified when the healthAggregationPolicy is created, and cannot be\nmutated.",
"enum": [
"BACKEND_SERVICE_POLICY",
"DNS_PUBLIC_IP_POLICY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the health aggregation policy\nresides. This field applies only to the regional resource. You must specify\nthis field as part of the HTTP request URL. It is not settable as a field\nin the request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL with id for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"HealthAggregationPolicyAggregatedList": {
"description": "Contains a list of HealthAggregationPoliciesScopedList.",
"id": "HealthAggregationPolicyAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "HealthAggregationPoliciesScopedList",
"description": "Name of the scope containing this set of HealthAggregationPolicies."
},
"description": "A list of HealthAggregationPoliciesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#healthAggregationPolicyAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthAggregationPolicyList": {
"id": "HealthAggregationPolicyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of HealthAggregationPolicy resources.",
"items": {
"$ref": "HealthAggregationPolicy"
},
"type": "array"
},
"kind": {
"default": "compute#healthAggregationPolicyList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthAggregationPolicy for health aggregation\npolicies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthCheck": {
"description": "Represents a health check resource.\n\nGoogle Compute Engine has two health check resources:\n\n* [Regional](/compute/docs/reference/rest/v1/regionHealthChecks)\n* [Global](/compute/docs/reference/rest/v1/healthChecks)\n\nThese health check resources can be used for load balancing and for\nautohealing VMs in a managed instance group (MIG).\n\n**Load balancing**\n\nHealth check requirements vary depending on the type of load balancer. For\ndetails about the type of health check supported for\neach load balancer and corresponding backend type,\nsee Health\nchecks overview: Load balancer guide.\n\n**Autohealing in MIGs**\n\nThe health checks that you use for autohealing VMs in a MIG can be either\nregional or global. For more information, see  Set up an\napplication health check and autohealing.\n\nFor more information, seeHealth checks\noverview.",
"id": "HealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is 5\nseconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp in3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"grpcHealthCheck": {
"$ref": "GRPCHealthCheck"
},
"grpcTlsHealthCheck": {
"$ref": "GRPCTLSHealthCheck"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this\nmany 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#healthCheck",
"description": "Output only. Type of the resource.",
"readOnly": true,
"type": "string"
},
"logConfig": {
"$ref": "HealthCheckLogConfig",
"description": "Configure logging on this health check."
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nFor example, a name that is 1-63 characters long, matches the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with\nRFC1035. This regular expression describes a name where the first\ncharacter is a lowercase letter, and all following characters are a dash,\nlowercase letter, or digit, except the last character, which isn't a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] Region where the health check resides.  Not applicable to\nglobal health checks.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"sourceRegions": {
"description": "The list of cloud regions from which health checks are performed. If any\nregions are specified, then exactly 3 regions should be specified. The\nregion names must be valid names of Google Cloud regions.\nThis can only be set for global health check.\nIf this list is non-empty, then there are restrictions\non what other health check fields are supported and what other resources\ncan use this health check:\n   \n   - SSL, HTTP2, and GRPC protocols are not supported.\n   - The TCP request field is not supported.\n   - The proxyHeader field for HTTP, HTTPS, and TCP is not\n   supported.\n   - The checkIntervalSec field must be at least 30.\n   - The health check cannot be used with BackendService nor with managed\n   instance group auto-healing.",
"items": {
"type": "string"
},
"type": "array"
},
"sslHealthCheck": {
"$ref": "SSLHealthCheck"
},
"tcpHealthCheck": {
"$ref": "TCPHealthCheck"
},
"timeoutSec": {
"description": "How long (in seconds) to wait before claiming failure. The default value is\n5 seconds. It is invalid for timeoutSec to have greater\nvalue than checkIntervalSec.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Specifies the type of the healthCheck, either TCP,SSL, HTTP, HTTPS,HTTP2 or GRPC. Exactly one of the\nprotocol-specific health check fields must be specified, which must matchtype field.",
"enum": [
"GRPC",
"GRPC_WITH_TLS",
"HTTP",
"HTTP2",
"HTTPS",
"INVALID",
"SSL",
"TCP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this many\nconsecutive 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthCheckLogConfig": {
"description": "Configuration of logging on a health check. If logging is enabled, logs\nwill be exported to Stackdriver.",
"id": "HealthCheckLogConfig",
"properties": {
"enable": {
"description": "Indicates whether or not to export logs. This is false by default, which\nmeans no health check logging will be done.",
"type": "boolean"
}
},
"type": "object"
},
"HealthCheckReference": {
"description": "A full or valid partial URL to a health check. For example, the following are\nvalid URLs:\n   \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"
},
"HealthCheckService": {
"description": "Represents a Health-Check as a Service resource.",
"id": "HealthCheckService",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthCheckService. An up-to-date fingerprint must\nbe provided in order to patch/update the HealthCheckService; Otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nHealthCheckService.",
"format": "byte",
"type": "string"
},
"healthChecks": {
"description": "A list of URLs to the HealthCheck resources. Must have\nat least one HealthCheck, and not more than 10 for regionalHealthCheckService, and not more than 1 for globalHealthCheckService.HealthCheck resources must haveportSpecification=USE_SERVING_PORT orportSpecification=USE_FIXED_PORT. For\nregional HealthCheckService, theHealthCheck must be regional and in the same\nregion. For global HealthCheckService,HealthCheck must be global. Mix of regional and globalHealthChecks is not supported. Multiple regionalHealthChecks must belong to the same region. RegionalHealthChecks must belong to the same region as zones ofNetworkEndpointGroups. For globalHealthCheckService using globalINTERNET_IP_PORT NetworkEndpointGroups, the\nglobal HealthChecks must specify sourceRegions,\nand HealthChecks that specify sourceRegions can\nonly be used with global INTERNET_IP_PORTNetworkEndpointGroups.",
"items": {
"type": "string"
},
"type": "array"
},
"healthStatusAggregationPolicy": {
"description": "Optional. Policy for how the results from multiple health checks\nfor the same endpoint are aggregated. Defaults to NO_AGGREGATION\nif unspecified.\n   \n   - NO_AGGREGATION. An EndpointHealth message is\n   returned for each  pair in the health check\n   service.\n   - AND. If any health check of an endpoint reportsUNHEALTHY, then UNHEALTHY is theHealthState of the endpoint. If all health checks reportHEALTHY, the HealthState of the endpoint isHEALTHY.\n\n.\nThis is only allowed with regional HealthCheckService.",
"enum": [
"AND",
"NO_AGGREGATION"
],
"enumDescriptions": [
"If any backend's health check reports UNHEALTHY,\nthen UNHEALTHY is the HealthState of\nthe entire health check service. If all backend's are healthy,\nthe HealthState of the health check service isHEALTHY.",
"An EndpointHealth message is returned for each\nbackend in the health check service."
],
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#healthCheckService",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#healthCheckServicefor health check services.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"networkEndpointGroups": {
"description": "A list of URLs to the NetworkEndpointGroup\nresources. Must not have more than 100.  For regionalHealthCheckService, NEGs must be in\nzones in the region of the HealthCheckService. For globalHealthCheckServices, the NetworkEndpointGroups\nmust be global INTERNET_IP_PORT.",
"items": {
"type": "string"
},
"type": "array"
},
"notificationEndpoints": {
"description": "A list of URLs to the NotificationEndpoint\nresources. Must not have more than 10.  A list of endpoints for\nreceiving notifications of change in health status. For regionalHealthCheckService,NotificationEndpoint must be regional and in the\nsame region. For global HealthCheckService,NotificationEndpoint must be global.",
"items": {
"type": "string"
},
"type": "array"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the health check service\nresides. This field is not applicable to global health check services.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"HealthCheckServiceAggregatedList": {
"description": "Contains a list of HealthCheckServicesScopedList.",
"id": "HealthCheckServiceAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "HealthCheckServicesScopedList",
"description": "Name of the scope containing this set of HealthCheckServices."
},
"description": "A list of HealthCheckServicesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#healthCheckServiceAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthCheckServiceReference": {
"description": "A full or valid partial URL to a health check service. For example, the\nfollowing are valid URLs:\n   \n   - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n   - projects/project-id/regions/us-west1/healthCheckServices/health-check-service\n   - regions/us-west1/healthCheckServices/health-check-service",
"id": "HealthCheckServiceReference",
"properties": {
"healthCheckService": {
"type": "string"
}
},
"type": "object"
},
"HealthCheckServicesList": {
"id": "HealthCheckServicesList",
"properties": {
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "Output only. A list of HealthCheckService resources.",
"items": {
"$ref": "HealthCheckService"
},
"readOnly": true,
"type": "array"
},
"kind": {
"default": "compute#healthCheckServicesList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthCheckServicesList for lists of\nHealthCheckServices.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthCheckServicesScopedList": {
"id": "HealthCheckServicesScopedList",
"properties": {
"resources": {
"description": "A list of HealthCheckServices contained in this scope.",
"items": {
"$ref": "HealthCheckService"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthSource": {
"description": "Represents a health source.\n\nA health source resource specifies the source resources and the health\naggregation policy applied to the source resources to determine the\naggregated health status.",
"id": "HealthSource",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a HealthSource. An up-to-date fingerprint\nmust be provided in order to patch the HealthSource; Otherwise, the request\nwill fail with error 412 conditionNotMet. To see the latest\nfingerprint, make a get() request to retrieve the\nHealthSource.",
"format": "byte",
"type": "string"
},
"healthAggregationPolicy": {
"description": "URL to the HealthAggregationPolicy resource. Must be set. Must\nbe regional and in the same region as the HealthSource. Can be\nmutated.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#healthSource",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the health source resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL with id for the resource.",
"readOnly": true,
"type": "string"
},
"sourceType": {
"description": "Specifies the type of the HealthSource. The only allowed value\nis BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated.",
"enum": [
"BACKEND_SERVICE"
],
"enumDescriptions": [
""
],
"type": "string"
},
"sources": {
"description": "URLs to the source resources. Must be size 1. Must be aBackendService if\nthe sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional\nand in the same region as the HealthSource (cross-region\ndeployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be\nmutated.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"HealthSourceAggregatedList": {
"description": "Contains a list of HealthSourcesScopedList.",
"id": "HealthSourceAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "HealthSourcesScopedList",
"description": "Name of the scope containing this set of HealthSources."
},
"description": "A list of HealthSourcesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#healthSourceAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthSourceHealth": {
"description": "Response message for RegionHealthSources.GetHealth",
"id": "HealthSourceHealth",
"properties": {
"healthState": {
"description": "Health state of the HealthSource.",
"enum": [
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#healthSourceHealth",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#healthSourceHealth for the health of health sources.",
"readOnly": true,
"type": "string"
},
"sources": {
"description": "Health state details of the sources.",
"items": {
"$ref": "HealthSourcesGetHealthResponseSourceInfo"
},
"type": "array"
}
},
"type": "object"
},
"HealthSourceList": {
"id": "HealthSourceList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of HealthSource resources.",
"items": {
"$ref": "HealthSource"
},
"type": "array"
},
"kind": {
"default": "compute#healthSourceList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"HealthSourcesGetHealthResponseSourceInfo": {
"id": "HealthSourcesGetHealthResponseSourceInfo",
"properties": {
"backends": {
"description": "Represents an instance group or network endpoint group behind the source\nbackend service. Only used if the sourceType of the regionHealthSource\nis BACKEND_SERVICE.",
"items": {
"$ref": "HealthSourcesGetHealthResponseSourceInfoBackendInfo"
},
"type": "array"
},
"forwardingRule": {
"description": "Fully qualified URL of the forwarding rule associated with the source\nresource if it is a L4ILB backend service.",
"type": "string"
},
"source": {
"description": "Fully qualified URL of the associated source resource. This is always a\nbackend service URL.",
"type": "string"
}
},
"type": "object"
},
"HealthSourcesGetHealthResponseSourceInfoBackendInfo": {
"id": "HealthSourcesGetHealthResponseSourceInfoBackendInfo",
"properties": {
"endpointCount": {
"description": "Total number of endpoints when determining the health of the\nregionHealthSource.",
"format": "int32",
"type": "integer"
},
"group": {
"description": "Fully qualified URL of an instance group or network endpoint group\nbehind the source backend service.",
"type": "string"
},
"healthyEndpointCount": {
"description": "Number of endpoints considered healthy when determining health of the\nregionHealthSource.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"HealthSourcesScopedList": {
"id": "HealthSourcesScopedList",
"properties": {
"healthSources": {
"description": "A list of HealthSources contained in this scope.",
"items": {
"$ref": "HealthSource"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nhealth sources when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata defined as annotations for network endpoint.",
"type": "object"
},
"forwardingRule": {
"description": "URL of the forwarding rule associated with the health status of the\ninstance.",
"type": "string"
},
"forwardingRuleIp": {
"description": "A forwarding rule IP address assigned to this instance.",
"type": "string"
},
"healthState": {
"description": "Health state of the IPv4 address of the instance.",
"enum": [
"HEALTHY",
"UNHEALTHY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"instance": {
"description": "URL of the instance resource.",
"type": "string"
},
"ipAddress": {
"description": "For target pool based Network Load Balancing, it indicates the forwarding\nrule's IP address assigned to this instance. For other types of load\nbalancing, the field indicates VM internal ip.",
"type": "string"
},
"ipv6Address": {
"type": "string"
},
"ipv6HealthState": {
"description": "Health state of the IPv6 address of the instance.",
"enum": [
"HEALTHY",
"UNHEALTHY"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"port": {
"description": "The named port of the instance group, not necessarily the port that is\nhealth-checked.",
"format": "int32",
"type": "integer"
},
"weight": {
"type": "string"
},
"weightError": {
"enum": [
"INVALID_WEIGHT",
"MISSING_WEIGHT",
"UNAVAILABLE_WEIGHT",
"WEIGHT_NONE"
],
"enumDescriptions": [
"The response to a Health Check probe had the HTTP response header field\nX-Load-Balancing-Endpoint-Weight, but its content was invalid (i.e., not\na non-negative single-precision floating-point number in decimal string\nrepresentation).",
"The response to a Health Check probe did not have the HTTP response\nheader field X-Load-Balancing-Endpoint-Weight.",
"This is the value when the accompanied health status is either TIMEOUT\n(i.e.,the Health Check probe was not able to get a response in time) or\nUNKNOWN. For the latter, it should be typically because there has not\nbeen sufficient time to parse and report the weight for a new backend\n(which is with 0.0.0.0 ip address). However, it can be also due to an\noutage case for which the health status is explicitly reset to UNKNOWN.",
"This is the default value when WeightReportMode is DISABLE,\nand is also the initial value when WeightReportMode has just updated to\nENABLE or DRY_RUN and there has not been\nsufficient time to parse and report the backend weight."
],
"type": "string"
}
},
"type": "object"
},
"HealthStatusForNetworkEndpoint": {
"id": "HealthStatusForNetworkEndpoint",
"properties": {
"backendService": {
"$ref": "BackendServiceReference",
"description": "URL of the backend service associated with the health state of the network\nendpoint."
},
"forwardingRule": {
"$ref": "ForwardingRuleReference",
"description": "URL of the forwarding rule associated with the health state of the network\nendpoint."
},
"healthCheck": {
"$ref": "HealthCheckReference",
"description": "URL of the health check associated with the health state of the network\nendpoint."
},
"healthCheckService": {
"$ref": "HealthCheckServiceReference",
"description": "URL of the health check service associated with the health state of the\nnetwork endpoint."
},
"healthState": {
"description": "Health state of the network endpoint determined based on the health checks\nconfigured.",
"enum": [
"DRAINING",
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"Endpoint is being drained.",
"Endpoint is healthy.",
"Endpoint is unhealthy.",
"Health status of the endpoint is unknown."
],
"type": "string"
},
"ipv6HealthState": {
"description": "Health state of the ipv6 network endpoint determined based on the health\nchecks configured.",
"enum": [
"DRAINING",
"HEALTHY",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"Endpoint is being drained.",
"Endpoint is healthy.",
"Endpoint is unhealthy.",
"Health status of the endpoint is unknown."
],
"type": "string"
}
},
"type": "object"
},
"Help": {
"description": "Provides links to documentation or for performing an out of band action.\n\nFor example, if a quota check failed with an error indicating the calling\nproject hasn't enabled the accessed service, this can contain a URL pointing\ndirectly to the right place in the developer console to flip the bit.",
"id": "Help",
"properties": {
"links": {
"description": "URL(s) pointing to additional information on handling the current error.",
"items": {
"$ref": "HelpLink"
},
"type": "array"
}
},
"type": "object"
},
"HelpLink": {
"description": "Describes a URL link.",
"id": "HelpLink",
"properties": {
"description": {
"description": "Describes what the link offers.",
"type": "string"
},
"url": {
"description": "The URL of the link.",
"type": "string"
}
},
"type": "object"
},
"HostRule": {
"description": "UrlMaps\nA host-matching rule for a URL. If matched, will use the namedPathMatcher to select the BackendService.",
"id": "HostRule",
"properties": {
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"hosts": {
"description": "The list of host patterns to match. They must be valid hostnames with\noptional port numbers in the format host:port.* matches any string of ([a-z0-9-.]*). In\nthat case, * must be the first character, and if followed by\nanything, the immediate following character must be either -\nor ..\n\n* based matching is not supported when the URL map is bound\nto a target gRPC proxy that has the validateForProxyless field\nset to true.",
"items": {
"type": "string"
},
"type": "array"
},
"pathMatcher": {
"description": "The name of the PathMatcher to use to match the path portion\nof 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.\n\nThe value must be from 200 to 599 inclusive.\n\nFor gRPC protocol, the gRPC status code is mapped to HTTP status code\naccording to this \nmapping table. HTTP status 200 is mapped to gRPC status\nUNKNOWN. Injecting an OK status is currently not supported by\nTraffic Director.",
"format": "uint32",
"type": "integer"
},
"percentage": {
"description": "The percentage of traffic for connections, operations, or requests\nthat is aborted as part of fault injection.\n\nThe value must be from 0.0 to 100.0 inclusive.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"HttpFaultDelay": {
"description": "Specifies the delay introduced by the load balancer before forwarding the\nrequest 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 for connections, operations, or requests for\nwhich a delay is introduced as part of fault injection.\n\nThe value must be from 0.0 to 100.0 inclusive.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"HttpFaultInjection": {
"description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by the load balancer on a percentage of requests before sending\nthose request to the backend service. Similarly requests from clients can be\naborted by the load balancer for a percentage of requests.",
"id": "HttpFaultInjection",
"properties": {
"abort": {
"$ref": "HttpFaultAbort",
"description": "The specification for how client requests are aborted as part of fault\ninjection."
},
"delay": {
"$ref": "HttpFaultDelay",
"description": "The specification for how client requests are delayed as part of fault\ninjection, before being sent to a backend service."
}
},
"type": "object"
},
"HttpHeaderAction": {
"description": "The request and response header transformations that take effect before\nthe request is passed along to the selected backendService.",
"id": "HttpHeaderAction",
"properties": {
"requestHeadersToAdd": {
"description": "Headers to add to a matching request before forwarding the request to thebackendService.",
"items": {
"$ref": "HttpHeaderOption"
},
"type": "array"
},
"requestHeadersToRemove": {
"description": "A list of header names for headers that need to be removed from the\nrequest before forwarding the request to the backendService.",
"items": {
"type": "string"
},
"type": "array"
},
"responseHeadersToAdd": {
"description": "Headers to add the response before sending the response back to the\nclient.",
"items": {
"$ref": "HttpHeaderOption"
},
"type": "array"
},
"responseHeadersToRemove": {
"description": "A list of header names for headers that need to be removed from the\nresponse before 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.\n\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.\n\nFor matching against the HTTP request's authority, use a headerMatch\nwith the header name \":authority\".\n\nFor matching a request's method, use the headerName \":method\".\n\nWhen the URL map is bound to a target gRPC proxy that has\nthe validateForProxyless field set to true, only\nnon-binary\nuser-specified custom metadata and the `content-type` header are supported.\nThe following transport-level headers cannot be used in header matching\nrules:\n`:authority`, `:method`, `:path`, `:scheme`, `user-agent`,\n`accept-encoding`, `content-encoding`, `grpc-accept-encoding`,\n`grpc-encoding`, `grpc-previous-rpc-attempts`, `grpc-tags-bin`,\n`grpc-timeout` and `grpc-trace-bin`.",
"type": "string"
},
"invertMatch": {
"description": "If set to false, the headerMatch is considered a\nmatch if the preceding match criteria are met. If set to true,\nthe headerMatch is considered a match if the preceding\nmatch criteria are NOT met.\n\nThe default setting is false.",
"type": "boolean"
},
"prefixMatch": {
"description": "The value of the header must start with the contents ofprefixMatch.\n\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\nmatch takes place whether or not the request's header has a value.\n\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\nspecified in rangeMatch. If the header does not contain an\ninteger, number or is empty, the match fails.\n\nFor example for a range [-5, 0]\n   \n   \n      - -3 will match.\n      - 0 will not match.\n      - 0.25 will not match.\n      - -3someString will not match.\n\nOnly one of exactMatch, prefixMatch,suffixMatch, regexMatch,presentMatch or rangeMatch must be set.\n\nrangeMatch is not supported for load balancers\nthat have loadBalancingScheme set to EXTERNAL."
},
"regexMatch": {
"description": "The value of the header must match the regular expression specified inregexMatch.\nFor more information about regular expression syntax, see Syntax.\n\nFor matching against a port specified in the HTTP request, use a\nheaderMatch with headerName set to PORT and a regular expression that\nsatisfies the RFC2616 Host header's port specifier.\n\nOnly one of exactMatch, prefixMatch,suffixMatch, regexMatch,presentMatch or rangeMatch must be set.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED\n(regional scope) or INTERNAL_MANAGED.",
"type": "string"
},
"suffixMatch": {
"description": "The value of the header must end with the contents ofsuffixMatch.\n\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\nthat already\nexist for the header. If true, headerValue is set for the\nheader, discarding any values that were set for that header.\n\nThe default value is true,\nunless a variable is present in headerValue,\nin which case the default value is false.\n.",
"type": "boolean"
}
},
"type": "object"
},
"HttpHealthCheck": {
"description": "Represents a legacy HTTP Health Check resource.\n\nLegacy HTTP health checks are now only required by target pool-based network\nload balancers. For all other load balancers, including backend service-based\nnetwork load balancers, and for managed instance group auto-healing, you must\nuse modern (non-legacy) health checks.\n\nFor more information, seeHealth checks\noverview.",
"id": "HttpHealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is5 seconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this\nmany 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\nempty (default value), the public IP on behalf of which this health check\nis performed will be used.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#httpHealthCheck",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#httpHealthCheck for HTTP health checks.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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 is80.",
"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\nparameters. Must comply withRFC3986.",
"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 is5 seconds. It is invalid for timeoutSec to have\ngreater value than checkIntervalSec.",
"format": "int32",
"type": "integer"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this\nmany 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nparameter exactly matches the contents of exactMatch.\n\nOnly one of presentMatch, exactMatch, orregexMatch must be set.",
"type": "string"
},
"name": {
"description": "The name of the query parameter to match. The query parameter must exist in\nthe request, in the absence of which the request match fails.",
"type": "string"
},
"presentMatch": {
"description": "Specifies that the queryParameterMatch matches if the\nrequest contains the query parameter, irrespective of whether the\nparameter has a value or not.\n\nOnly one of presentMatch, exactMatch, orregexMatch must be set.",
"type": "boolean"
},
"regexMatch": {
"description": "The queryParameterMatch matches if the value of the\nparameter matches the regular expression specified byregexMatch. For\nmore information about regular expression syntax, see Syntax.\n\nOnly one of presentMatch, exactMatch, orregexMatch must be set.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED\n(regional scope) or INTERNAL_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"HttpRedirectAction": {
"description": "Specifies settings for an HTTP redirect.",
"id": "HttpRedirectAction",
"properties": {
"hostRedirect": {
"description": "The host that is used in the redirect response instead of the one that\nwas supplied in the request.\n\nThe value must be from 1 to 255\ncharacters.",
"type": "string"
},
"httpsRedirect": {
"description": "If set to true, the URL scheme in the redirected request is\nset to HTTPS.\nIf set to false, the URL scheme of the redirected request\nremains the same as that of the request.\n\nThis must only be set for URL maps used inTargetHttpProxys. Setting this true forTargetHttpsProxy is not permitted.\n\nThe default is set to false.",
"type": "boolean"
},
"pathRedirect": {
"description": "The path that is used in the redirect response instead of the one\nthat was supplied in the request.\n\npathRedirect cannot be supplied together withprefixRedirect. Supply one alone or neither. If neither is\nsupplied, the path of the original request is used for the redirect.\n\nThe value must be from 1 to 1024 characters.",
"type": "string"
},
"prefixRedirect": {
"description": "The prefix that replaces the prefixMatch specified in\nthe HttpRouteRuleMatch, retaining the remaining portion\nof the URL before redirecting the request.\n\nprefixRedirect cannot be supplied together withpathRedirect. Supply one alone or neither. If neither is\nsupplied, the path of the original request is used for the redirect.\n\nThe value must be from 1 to 1024 characters.",
"type": "string"
},
"redirectResponseCode": {
"description": "The HTTP Status code to use for this RedirectAction.\n\nSupported values are:\n   \n   - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds\n   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\n   method is retained.\n   - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request\n   method is retained.",
"enum": [
"FOUND",
"MOVED_PERMANENTLY_DEFAULT",
"PERMANENT_REDIRECT",
"SEE_OTHER",
"TEMPORARY_REDIRECT"
],
"enumDescriptions": [
"Http Status Code 302 - Found.",
"Http Status Code 301 - Moved Permanently.",
"Http Status Code 308 - Permanent Redirect maintaining HTTP method.",
"Http Status Code 303 - See Other.",
"Http Status Code 307 - Temporary Redirect maintaining HTTP method."
],
"type": "string"
},
"stripQuery": {
"description": "If set to true, any accompanying query portion of the original\nURL is\nremoved before redirecting the request. If set to false, the\nquery portion of the original URL is retained.\n\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 > 0.\nIf not specified, defaults to 1.",
"format": "uint32",
"type": "integer"
},
"perTryTimeout": {
"$ref": "Duration",
"description": "Specifies a non-zero timeout per retry attempt.\n\nIf not specified, will use the timeout set in theHttpRouteAction field.\nIf timeout in the HttpRouteAction field is not set, this field\nuses the largest timeout\namong all backend services associated with the route.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas the validateForProxyless field set to true."
},
"retryConditions": {
"description": "Specifies one or more conditions when this retry policy applies. Valid\nvalues are:\n   \n   - 5xx: retry is attempted if the instance or endpoint\n   responds with any 5xx response code, or if the instance or\n   endpoint does not respond at all. For example, disconnects, reset, read\n   timeout, connection failure, and refused streams.\n   - gateway-error: Similar to 5xx, but only\n   applies to response codes 502, 503 or504.\n   - connect-failure: a retry is attempted on failures\n   connecting to the instance or endpoint. For example, connection\n   timeouts.\n   - retriable-4xx: a retry is attempted if the instance\n   or endpoint responds with a 4xx response code.\n   The only error that you can retry is error code 409.\n   - refused-stream: a retry is attempted if the instance\n   or endpoint resets the stream with a REFUSED_STREAM error\n   code. This reset type indicates that it is safe to retry.\n   - cancelled: a retry is attempted if the gRPC status\n   code in the response header is set to cancelled.\n   - deadline-exceeded: a retry is attempted if the gRPC\n   status code in the response header is set todeadline-exceeded.\n   - internal: a retry is attempted if the gRPC\n   status code in the response header is set tointernal.\n   - resource-exhausted: a retry is attempted if the gRPC\n   status code in the response header is set toresource-exhausted.\n   - unavailable: a retry is attempted if the gRPC\n   status code in the response header is set tounavailable.\n\nOnly the following codes are supported when the URL map is bound to\ntarget gRPC proxy that has validateForProxyless field set to true.\n   \n   - cancelled\n   - deadline-exceeded\n   - internal\n   - resource-exhausted\n   - unavailable",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"HttpRouteAction": {
"id": "HttpRouteAction",
"properties": {
"cachePolicy": {
"$ref": "CachePolicy",
"description": "Specifies the cache policy configuration for matched traffic. Available\nonly for Global `EXTERNAL_MANAGED` load balancer schemes. At least one\nproperty must be specified. This policy cannot be specified if any target\nbackend has Identity-Aware Proxy enabled."
},
"corsPolicy": {
"$ref": "CorsPolicy",
"description": "The specification for allowing client-side cross-origin requests. For more\ninformation about the W3C recommendation for cross-origin resource sharing\n(CORS), see Fetch API Living\nStandard.\n\nNot supported when the URL map is bound to a target gRPC proxy."
},
"faultInjectionPolicy": {
"$ref": "HttpFaultInjection",
"description": "The specification for fault injection introduced into traffic to test\nthe resiliency of clients to backend service failure. As part of fault\ninjection, when clients send requests to a backend service, delays can be\nintroduced by a load balancer on a percentage of requests before sending\nthose requests to the backend service. Similarly requests from clients can\nbe aborted by the load balancer for a percentage of requests.timeout and retry_policy is ignored by clients\nthat are configured with a fault_injection_policy if:\n1. The traffic is generated by fault injection AND\n2. The fault injection is not a delay fault injection.\nFault injection is not supported with the classic Application Load Balancer\n. To see which load balancers support fault injection,\nsee Load\nbalancing: Routing and traffic management features."
},
"maxStreamDuration": {
"$ref": "Duration",
"description": "Specifies the maximum duration (timeout) for streams on the selected route.\nUnlike the timeout field where the timeout duration starts\nfrom the time the request has been fully processed (known as*end-of-stream*),\nthe duration in this field is computed from the beginning of the stream\nuntil the response has been processed, including all retries. A\nstream that does not complete in this duration is closed.\n\nIf not specified, this field uses the maximummaxStreamDuration value among all backend services associated\nwith the route.\n\nThis field is only allowed if the Url map is used with backend services\nwith loadBalancingScheme set toINTERNAL_SELF_MANAGED."
},
"requestMirrorPolicy": {
"$ref": "RequestMirrorPolicy",
"description": "Specifies the policy on how requests intended for the route's backends\nare shadowed to a separate mirrored backend service. The load balancer does\nnot wait for responses from the shadow service. Before sending traffic\nto the shadow service, the host / authority header is suffixed with-shadow.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas the validateForProxyless field set to true."
},
"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\ntime the request has been fully processed (known as *end-of-stream*)\nup until the response has been processed. Timeout includes\nall retries.\n\nIf not specified, this field uses the largest timeout among all backend\nservices associated with the route.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true."
},
"urlRewrite": {
"$ref": "UrlRewrite",
"description": "The spec to modify the URL of the request, before forwarding the request\nto the matched service.\n\n urlRewrite is the only action supported in UrlMaps\nfor classic Application Load Balancers.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas the validateForProxyless field set to true."
},
"weightedBackendServices": {
"description": "A list of weighted backend services to send traffic to when a route match\noccurs. The weights determine the fraction of traffic that flows to\ntheir corresponding backend service. If all traffic needs to\ngo to a single backend service, there must be oneweightedBackendService with weight set to a non-zero number.\n\nAfter a backend service is identified and before forwarding\nthe request to\nthe backend service, advanced routing actions such as URL rewrites and\nheader transformations are applied depending on additional settings\nspecified in this HttpRouteAction.",
"items": {
"$ref": "WeightedBackendService"
},
"type": "array"
}
},
"type": "object"
},
"HttpRouteRule": {
"description": "The HttpRouteRule setting specifies how to match an HTTP request\nand the corresponding routing action that load balancing proxies perform.",
"id": "HttpRouteRule",
"properties": {
"customErrorResponsePolicy": {
"$ref": "CustomErrorResponsePolicy",
"description": "customErrorResponsePolicy specifies how the Load\nBalancer returns error responses when BackendServiceorBackendBucket responds with an error. \n\nIf a policy for an\nerror code is not configured for the RouteRule, a policy for\nthe error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If\none is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy\nconfigured in UrlMap.defaultCustomErrorResponsePolicy takes\neffect. \n\nFor example, consider a UrlMap with the following configuration:\n   \n   \n     - UrlMap.defaultCustomErrorResponsePolicy are configured\n     with policies for 5xx and 4xx errors\n     - A RouteRule for /coming_soon/ is configured for the\n     error code 404.\n\nIf the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy\ntakes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,\nthe policy in RouteRule.customErrorResponsePolicy takes\neffect. If any of the requests in this example encounter a 500\nerror code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect. \n\nWhen\nused in conjunction withrouteRules.routeAction.retryPolicy, retries take\nprecedence. Only once all retries are exhausted, thecustomErrorResponsePolicy is applied. While attempting\na retry, if load balancer is successful in reaching the\nservice, the customErrorResponsePolicy is ignored and\nthe response from the service is returned to the client.\n\ncustomErrorResponsePolicy is supported only for\nglobal external Application Load Balancers."
},
"description": {
"description": "The short description conveying the intent of this routeRule.\n\n\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\nfor the selected backendService.\n\nThe headerAction value specified here is applied before the\nmatching pathMatchers[].headerAction and afterpathMatchers[].routeRules[].routeAction.weightedBackendService.backendServiceWeightAction[].headerAction\n\nHeaderAction is not supported for load balancers\nthat have\ntheir loadBalancingScheme set to EXTERNAL.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true."
},
"matchRules": {
"description": "The list of criteria for matching attributes of a request to thisrouteRule. This list has OR semantics: the request matches\nthis routeRule when any of thematchRules are satisfied. However predicates within\na given matchRule have AND semantics. All predicates\nwithin a matchRule must match for the request to\nmatch the rule.",
"items": {
"$ref": "HttpRouteRuleMatch"
},
"type": "array"
},
"priority": {
"description": "For routeRules within a given pathMatcher,\npriority determines the order in which a load balancer interpretsrouteRules. RouteRules are evaluated in order\nof priority, from the lowest to highest number. The priority of a\nrule decreases as its number increases (1, 2, 3, N+1). The first rule\nthat matches the request is applied.\n\n\nYou cannot configure two or more routeRules with the same priority.\nPriority for each rule must be set to a number from 0 to 2147483647\ninclusive.\n\n\nPriority numbers can have gaps, which enable you to add or remove rules\nin the future without affecting the rest of the rules. For example, 1, 2,\n3, 4, 5, 9, 12, 16 is a valid series of priority numbers to which you\ncould add rules numbered from 6 to 8, 10 to 11, and 13 to 15 in the future\nwithout any impact on existing rules.",
"format": "int32",
"type": "integer"
},
"routeAction": {
"$ref": "HttpRouteAction",
"description": "In response to a matching matchRule, the load balancer\nperforms advanced routing actions, such as URL rewrites and header\ntransformations, before forwarding the request to the selected backend.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.\n\n\nURL maps for classic Application Load Balancers only support\nthe urlRewrite action within a route rule'srouteAction."
},
"service": {
"description": "The full or partial URL of the backend service resource to which traffic\nis directed if this rule is matched. If routeAction is\nalso specified, advanced routing actions, such as URL rewrites,\ntake effect before sending the request to the backend.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.",
"type": "string"
},
"urlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When this rule is matched, the request is redirected to a URL\nspecified by urlRedirect.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.\n\n\nNot supported when the URL map is bound to a target gRPC proxy."
}
},
"type": "object"
},
"HttpRouteRuleMatch": {
"description": "HttpRouteRuleMatch specifies a set of criteria for matching\nrequests to an HttpRouteRule. All specified criteria must\nbe satisfied for a match to occur.",
"id": "HttpRouteRuleMatch",
"properties": {
"fullPathMatch": {
"description": "For satisfying the matchRule condition, the path of the\nrequest must exactly match the value specified infullPathMatch after removing any query parameters and anchor\nthat may be part of the original URL.\n\nfullPathMatch must be from 1 to 1024 characters.\n\nOnly one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be\nspecified.",
"type": "string"
},
"headerMatches": {
"description": "Specifies a list of header match criteria, all of which must match\ncorresponding headers in the request.",
"items": {
"$ref": "HttpHeaderMatch"
},
"type": "array"
},
"ignoreCase": {
"description": "Specifies that prefixMatch and fullPathMatch\nmatches are case sensitive.\n\nThe default value is false.\n\nignoreCase must not be used with regexMatch.\n\nNot supported when the URL map is bound to a target gRPC proxy.",
"type": "boolean"
},
"metadataFilters": {
"description": "Opaque filter criteria used by the load balancer to restrict routing\nconfiguration to a limited set of xDS\ncompliant clients. In their xDS requests to the load balancer, xDS clients\npresent node\nmetadata. When there is a match, the relevant routing configuration\nis made available to those proxies.\n\nFor each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least one of thefilterLabels must match the corresponding label provided in\nthe metadata. If its filterMatchCriteria is set to\nMATCH_ALL, then all of its filterLabels must match with\ncorresponding labels provided in the metadata. If multiple\nmetadata filters are specified, all of them need to be\nsatisfied in order to be considered a match.\n\nmetadataFilters specified here is applied after those\nspecified in ForwardingRule that refers to theUrlMap this HttpRouteRuleMatch belongs to.\n\nmetadataFilters only applies to load balancers that haveloadBalancingScheme set toINTERNAL_SELF_MANAGED.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true.",
"items": {
"$ref": "MetadataFilter"
},
"type": "array"
},
"pathTemplateMatch": {
"description": "If specified, this field defines a path template pattern that must match\nthe :path header after the query string is removed.\n\nA path template pattern can include variables and wildcards.\nVariables are enclosed in curly braces, for example{variable_name}. Wildcards include * that\nmatches a single path segment, and ** that matches zero or\nmore path segments. The pattern must follow these rules:\n\n   \n      - The value must be between 1 and 1024 characters.\n      - The pattern must start with a leading slash (\"/\").\n      - No more than 5 operators (variables or wildcards) may appear in\n      the pattern.\n\nPrecisely one ofprefixMatch, fullPathMatch,regexMatch, or pathTemplateMatch must be\nset.",
"type": "string"
},
"prefixMatch": {
"description": "For satisfying the matchRule condition, the request's\npath must begin with the specified prefixMatch.prefixMatch must begin with a /.\n\nThe value must be from 1 to 1024 characters.\n\nThe * character inside a prefix match is\ntreated as a literal character, not as a wildcard.\n\nOnly one of prefixMatch, fullPathMatch,regexMatch or path_template_match can be\nused within a matchRule.",
"type": "string"
},
"queryParameterMatches": {
"description": "Specifies a list of query parameter match criteria, all of which must\nmatch corresponding query parameters in the request.\n\nNot supported when the URL map is bound to a target gRPC proxy.",
"items": {
"$ref": "HttpQueryParameterMatch"
},
"type": "array"
},
"regexMatch": {
"description": "For satisfying the matchRule condition, the path of the\nrequest must satisfy the regular expression specified inregexMatch after removing any query parameters and anchor\nsupplied with the original URL. For\nmore information about regular expression syntax, see Syntax.\n\nOnly one of prefixMatch, fullPathMatch,regexMatch or path_template_match must be\nspecified.\n\nRegular expressions can only be used when the loadBalancingScheme is\nset to INTERNAL_SELF_MANAGED, EXTERNAL_MANAGED\n(regional scope) or INTERNAL_MANAGED.",
"type": "string"
}
},
"type": "object"
},
"HttpsHealthCheck": {
"description": "Represents a legacy HTTPS Health Check resource.\n\nLegacy HTTPS health checks have been deprecated. If you are using a target\npool-based network load balancer, you must use a legacy HTTP (not HTTPS)\nhealth check. For all other load balancers, including backend service-based\nnetwork load balancers, and for managed instance group auto-healing, you must\nuse modern (non-legacy) health checks.\n\nFor more information, seeHealth checks\noverview.",
"id": "HttpsHealthCheck",
"properties": {
"checkIntervalSec": {
"description": "How often (in seconds) to send a health check. The default value is 5\nseconds.",
"format": "int32",
"type": "integer"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"healthyThreshold": {
"description": "A so-far unhealthy instance will be marked healthy after this\nmany 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\nempty (default value), the public IP on behalf of which this health check\nis performed will be used.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#httpsHealthCheck",
"description": "Output only. Type of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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\nis 443.",
"format": "int32",
"type": "integer"
},
"requestPath": {
"description": "The request path of the HTTPS health check request. The default value is\n\"/\". Must comply withRFC3986.",
"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\n5 seconds. It is invalid for timeoutSec to have a greater value than\ncheckIntervalSec.",
"format": "int32",
"type": "integer"
},
"unhealthyThreshold": {
"description": "A so-far healthy instance will be marked unhealthy after this\nmany 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nFor more information, read Images.",
"id": "Image",
"properties": {
"architecture": {
"description": "The architecture of the image. Valid values are\nARM64 or X86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"type": "string"
},
"archiveSizeBytes": {
"description": "Size of the image tar.gz archive stored in Google Cloud\nStorage (in bytes).",
"format": "int64",
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "Output only. The deprecation status associated with this image.",
"readOnly": true
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"diskSizeGb": {
"description": "Size of the image when restored onto a persistent disk (in GB).",
"format": "int64",
"type": "string"
},
"enableConfidentialCompute": {
"description": "Output only. Whether this image is created from a confidential compute mode disk.\n[Output Only]: This field is not set by user, but from source disk.",
"readOnly": true,
"type": "boolean"
},
"family": {
"description": "The name of the image family to which this image belongs. The image\nfamily name can be from a publicly managed image family provided by\nCompute Engine, or from a custom image family you create. For example,centos-stream-9 is a publicly available image family.\nFor more information, see Image\nfamily best practices.\n\nWhen creating disks, you can specify an image family instead of a specific\nimage name. The image family always returns its latest image that is not\ndeprecated. 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\nonly for bootable images. To see a list of available options, see theguestOSfeatures[].type parameter.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"imageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the image using acustomer-supplied\nencryption key.\n\nAfter you encrypt an image with a customer-supplied key, you must provide\nthe same key if you use the image later (e.g. to create a disk from\nthe image).\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the disk.\n\nIf you do not provide an encryption key when creating the image, then the\ndisk will be encrypted using an automatically generated key and you do not\nneed to provide a key to use the image later."
},
"kind": {
"default": "compute#image",
"description": "Output only. [Output Only] Type of the resource. Always compute#image for\nimages.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this image, which is\nessentially a hash of the labels used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an image.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this image. These can be later modified by\nthe 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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "ImageParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"rawDisk": {
"description": "The parameters of the raw disk image.",
"properties": {
"containerType": {
"description": "The format used to encode and transmit the block device, which should beTAR. This is just a container and transmission format and not\na runtime format. Provided by the client when the disk image is created.",
"enum": [
"TAR"
],
"enumDescriptions": [
""
],
"type": "string"
},
"sha1Checksum": {
"deprecated": true,
"description": "[Deprecated] This field is deprecated.\nAn optional SHA1 checksum of the disk image before unpackaging provided\nby the client when the disk image is created.",
"pattern": "[a-f0-9]{40}",
"type": "string"
},
"source": {
"description": "The full Google Cloud Storage URL or Artifact Registry path where the raw\ndisk image archive is stored.\nThe following are valid formats:\n   \n   - https://storage.googleapis.com/bucket_name/image_archive_name\n   - https://storage.googleapis.com/bucket_name/folder_name/image_archive_name\n   - projects/project/locations/location/repositories/repo/packages/package/versions/version_id\n   - projects/project/locations/location/repositories/repo/packages/package/versions/version_id@dirsum_sha256:hex_value\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n   \n   - The rawDisk.source URL \n   - The sourceDisk URL \n   - The sourceImage URL \n   - The sourceSnapshot URL",
"type": "string"
}
},
"type": "object"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"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.\nFor example, the following are valid values:\n   \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\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n   \n   - The rawDisk.source URL \n   - The sourceDisk URL \n   - The sourceImage URL \n   - The sourceSnapshot URL",
"type": "string"
},
"sourceDiskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Thecustomer-supplied\nencryption key of the source disk. Required if the source disk is\nprotected by a customer-supplied encryption key."
},
"sourceDiskId": {
"description": "Output only. [Output Only]\nThe ID value of the disk used to create this image. This value may be used\nto determine whether the image was taken from the current or a previous\ninstance of a given disk name.",
"readOnly": true,
"type": "string"
},
"sourceImage": {
"description": "URL of the source image used to create this image.\nThe following are valid formats for the URL:\n   \n   - https://www.googleapis.com/compute/v1/projects/project_id/global/\n   images/image_name\n   - projects/project_id/global/images/image_name\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n   \n   - The rawDisk.source URL \n   - The sourceDisk URL \n   - The sourceImage URL \n   - The sourceSnapshot URL",
"type": "string"
},
"sourceImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source image. Required if the\nsource image is protected by a customer-supplied encryption key."
},
"sourceImageId": {
"description": "Output only. [Output Only]\nThe ID value of the image used to create this image. This value may be used\nto determine whether the image was taken from the current or a previous\ninstance of a given image name.",
"readOnly": true,
"type": "string"
},
"sourceSnapshot": {
"description": "URL of the source snapshot used to create this image.\nThe following are valid formats for the URL:\n   \n   - https://www.googleapis.com/compute/v1/projects/project_id/global/\n   snapshots/snapshot_name\n   - projects/project_id/global/snapshots/snapshot_name\n\n\n\nIn order to create an image, you must provide the full or partial URL of\none of the following:\n   \n   - The rawDisk.source URL \n   - The sourceDisk URL \n   - The sourceImage URL \n   - The sourceSnapshot URL",
"type": "string"
},
"sourceSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied encryption key of the source snapshot. Required if\nthe source snapshot is protected by a customer-supplied encryption key."
},
"sourceSnapshotId": {
"description": "Output only. [Output Only]\nThe ID value of the snapshot used to create this image. This value may be\nused to determine whether the snapshot was taken from the current or a\nprevious instance of a given snapshot name.",
"readOnly": true,
"type": "string"
},
"sourceType": {
"default": "RAW",
"description": "The type of the image used to create this disk. The\ndefault and only valid value is RAW.",
"enum": [
"RAW"
],
"enumDescriptions": [
""
],
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of the image. An image can be used to create other\nresources, such as instances, only after the image has been successfully\ncreated and the status is set to READY. Possible\nvalues are FAILED, PENDING, orREADY.",
"enum": [
"DELETING",
"FAILED",
"PENDING",
"READY"
],
"enumDescriptions": [
"Image is deleting.",
"Image creation failed due to an error.",
"Image hasn't been created as yet.",
"Image has been successfully created."
],
"readOnly": true,
"type": "string"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the image (regional or\nmulti-regional).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ImageFamilyView": {
"id": "ImageFamilyView",
"properties": {
"image": {
"$ref": "Image",
"description": "The latest image that is part of the specified image family in the\nrequested location, and that is not deprecated."
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ImageParams": {
"description": "Additional image params.",
"id": "ImageParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the image. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"InitialStateConfig": {
"description": "Initial State for shielded instance,\nthese 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.\nFor more information, readVirtual Machine Instances.",
"id": "Instance",
"properties": {
"advancedMachineFeatures": {
"$ref": "AdvancedMachineFeatures",
"description": "Controls for advanced machine-related behavior features."
},
"canIpForward": {
"description": "Allows this instance to send and receive packets with non-matching\ndestination or source IPs. This is required if you plan to use this\ninstance to forward routes. For more information, seeEnabling IP Forwarding.",
"type": "boolean"
},
"confidentialInstanceConfig": {
"$ref": "ConfidentialInstanceConfig"
},
"cpuPlatform": {
"description": "Output only. [Output Only] The CPU platform used by this instance.",
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.",
"readOnly": true,
"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\ncreate the resource.",
"type": "string"
},
"disks": {
"description": "Array of disks associated with this instance. Persistent disks must be\ncreated 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\nthe instance's contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update the instance. You must always provide an\nup-to-date fingerprint hash in order to update the instance.\n\nTo see the latest fingerprint, make get() request to the\ninstance.",
"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\nRFC1035 compliant. If hostname is not specified, the default hostname is\n[INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and\n[INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts suspended data for an instance with acustomer-managed\nencryption key.\n\nIf you are creating a new instance, this field will encrypt the local SSD\nand in-memory contents of the instance during the suspend operation.\n\nIf you do not provide an encryption key when creating the instance, then\nthe local SSD and in-memory contents will be encrypted using\nan automatically generated key during the suspend operation."
},
"keyRevocationActionType": {
"description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and\n\"NONE\". The default value is \"NONE\" if it is not specified.",
"enum": [
"KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
"NONE",
"STOP"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Indicates user chose no operation.",
"Indicates user chose to opt for VM shutdown on key revocation."
],
"type": "string"
},
"kind": {
"default": "compute#instance",
"description": "Output only. [Output Only] Type of the resource. Always compute#instance\nfor instances.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for this request, which is essentially a hash of\nthe label's contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the\ninstance.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this instance. These can be later modified by\nthe setLabels method.",
"type": "object"
},
"lastStartTimestamp": {
"description": "Output only. [Output Only] Last start timestamp inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"lastStopTimestamp": {
"description": "Output only. [Output Only] Last stop timestamp inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"lastSuspendedTimestamp": {
"description": "Output only. [Output Only] Last suspended timestamp inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"machineType": {
"description": "Full or partial URL of the machine type resource to use for this instance,\nin the format:zones/zone/machineTypes/machine-type. This is provided by the client\nwhen the instance is created. For example, the following is a valid partial\nurl to a predefined\nmachine type:\n\nzones/us-central1-f/machineTypes/n1-standard-1\n\n\nTo create acustom\nmachine type, provide a URL to a machine type in the following format,\nwhere CPUS is 1 or an even number up to 32 (2,\n4, 6, ... 24, etc), and MEMORY is the total\nmemory for this instance. Memory must be a multiple of 256 MB and must\nbe supplied in MB (e.g. 5 GB of memory is 5120 MB):\n\nzones/zone/machineTypes/custom-CPUS-MEMORY\n\n\nFor example: zones/us-central1-f/machineTypes/custom-4-5120\nFor a full list of restrictions, read theSpecifications\nfor custom machine types.",
"type": "string"
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs assigned\nto this instance. This includes metadata keys that were explicitly defined\nfor the instance."
},
"minCpuPlatform": {
"description": "Specifies aminimum CPU\nplatform for the VM instance. Applicable values are the friendly names\nof CPU platforms, such as minCpuPlatform: \"Intel\nHaswell\" or minCpuPlatform: \"Intel Sandy\nBridge\".",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe 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\ninterfaces are configured to interact with other network services, such as\nconnecting to the internet. Multiple interfaces are supported\nper instance.",
"items": {
"$ref": "NetworkInterface"
},
"type": "array"
},
"networkPerformanceConfig": {
"$ref": "NetworkPerformanceConfig"
},
"params": {
"$ref": "InstanceParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"privateIpv6GoogleAccess": {
"description": "The private IPv6 google access type for the VM.\nIf not specified, use  INHERIT_FROM_SUBNETWORK as default.",
"enum": [
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
"INHERIT_FROM_SUBNETWORK"
],
"enumDescriptions": [
"Bidirectional private IPv6 access to/from Google services. If\nspecified, the subnetwork who is attached to the instance's default network\ninterface will be assigned an internal IPv6 prefix if it doesn't have\nbefore.",
"Outbound private IPv6 access from VMs in this subnet to Google services. If\nspecified, the subnetwork who is attached to the instance's default network\ninterface will be assigned an internal IPv6 prefix if it doesn't have\nbefore.",
"Each network interface inherits PrivateIpv6GoogleAccess from its\nsubnetwork."
],
"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"
},
"resourceStatus": {
"$ref": "ResourceStatus",
"description": "Output only. [Output Only] Specifies values set for instance attributes as\ncompared to the values requested by user in the corresponding input only\nfield.",
"readOnly": true
},
"satisfiesPzi": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"scheduling": {
"$ref": "Scheduling",
"description": "Sets the scheduling options for this instance."
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"serviceAccounts": {
"description": "A list of service accounts, with their specified scopes, authorized for\nthis instance. Only one service account per VM instance is supported.\n\nService accounts generate access tokens that can be accessed\nthrough the metadata server and used to authenticate applications on the\ninstance. SeeService Accounts\nfor more information.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig"
},
"shieldedInstanceIntegrityPolicy": {
"$ref": "ShieldedInstanceIntegrityPolicy"
},
"sourceMachineImage": {
"description": "Source machine image",
"type": "string"
},
"sourceMachineImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Source machine image encryption key when creating an instance from a\nmachine image."
},
"startRestricted": {
"description": "Output only. [Output Only] Whether a VM has been restricted for start because Compute\nEngine has detected suspicious activity.",
"readOnly": true,
"type": "boolean"
},
"status": {
"description": "Output only. [Output Only] The status of the instance. One of the\nfollowing values: PROVISIONING, STAGING,RUNNING, STOPPING, SUSPENDING,SUSPENDED, REPAIRING, andTERMINATED. For more information about the status of the\ninstance, see \nInstance life cycle.",
"enum": [
"DEPROVISIONING",
"PENDING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.",
"For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).",
"Resources are being allocated for the instance.",
"The instance is in repair.",
"The instance is running.",
"All required resources have been allocated and the instance\nis being started.",
"The instance has stopped successfully.",
"The instance is currently stopping (either being deleted or killed).",
"The instance has suspended.",
"The instance is suspending.",
"The instance has stopped (either by explicit action or underlying\nfailure)."
],
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. [Output Only] An optional, human-readable explanation of the status.",
"readOnly": true,
"type": "string"
},
"tags": {
"$ref": "Tags",
"description": "Tags to apply to this instance. Tags are used to identify valid\nsources or targets for network firewalls and are specified by the client\nduring instance creation. The tags can be later modified by the setTags\nmethod. Each tag within the list must comply withRFC1035.\nMultiple tags can be specified via the 'tags.items' field."
},
"workloadIdentityConfig": {
"$ref": "WorkloadIdentityConfig"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"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. [Output Only] Type of resource. Alwayscompute#instanceAggregatedList for aggregated lists of\nInstance resources.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InstanceConsumptionData": {
"id": "InstanceConsumptionData",
"properties": {
"consumptionInfo": {
"$ref": "InstanceConsumptionInfo",
"description": "Output only. Resources consumed by the instance.",
"readOnly": true
},
"instance": {
"description": "Output only. Server-defined URL for the instance.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceConsumptionInfo": {
"id": "InstanceConsumptionInfo",
"properties": {
"guestCpus": {
"description": "Output only. The number of virtual CPUs that are available to the instance.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"localSsdGb": {
"description": "Output only. The amount of local SSD storage available to the instance,\ndefined in GiB.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"memoryMb": {
"description": "Output only. The amount of physical memory available to the instance,\ndefined in MiB.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"minNodeCpus": {
"description": "Output only. The minimal guaranteed number of virtual CPUs that are reserved.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"InstanceFlexibilityPolicy": {
"description": "A flexible specification of machine types for instances to create.",
"id": "InstanceFlexibilityPolicy",
"properties": {
"instanceSelections": {
"additionalProperties": {
"$ref": "InstanceFlexibilityPolicyInstanceSelection"
},
"description": "Specification of alternative, flexible instance subsets.\nOne of them will be selected to create the instances\nbased on various criteria, like:\n- ranks,\n- location policy,\n- current capacity,\n- available reservations (you can specify affinity in\nInstanceProperties),\n- SWAN/GOOSE limitations.\nKey is an arbitrary, unique RFC1035 string that identifies the instance\nselection.",
"type": "object"
}
},
"type": "object"
},
"InstanceFlexibilityPolicyInstanceSelection": {
"description": "Specification of machine type to use. Every position inside this message\nis an alternative.\nThe count specified in the shape flexibility must not exceed the number\nof entries in per_instance_properties or the capacity of the\nname_pattern, if used.",
"id": "InstanceFlexibilityPolicyInstanceSelection",
"properties": {
"disks": {
"description": "Disks to be attached to the instances created from in this selection.\nThey override the disks specified in the instance properties.",
"items": {
"$ref": "AttachedDisk"
},
"type": "array"
},
"machineTypes": {
"description": "Alternative machine types to use for instances that are created from\nthese properties. This field only accepts a machine type names, for\nexample `n2-standard-4` and not URLs or partial URLs.",
"items": {
"type": "string"
},
"type": "array"
},
"rank": {
"description": "Rank when prioritizing the shape flexibilities.\nThe instance selections with rank are considered\nfirst, in the ascending order of the rank.\nIf not set, defaults to 0.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"InstanceGroup": {
"description": "Represents an Instance Group resource.\n\nInstance Groups can be used to configure a target forload\nbalancing.\n\nInstance groups can either be managed or unmanaged.\n\nTo create \nmanaged instance groups, use the instanceGroupManager orregionInstanceGroupManager resource instead.\n\nUse zonal unmanaged instance groups if you need to applyload\nbalancing to groups of heterogeneous instances or if you need to manage\nthe instances yourself. You cannot create regional unmanaged instance groups.\n\nFor more information, readInstance\ngroups.",
"id": "InstanceGroup",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp for this instance group inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Output only. [Output Only] The fingerprint of the named ports. The system\nuses this fingerprint to detect conflicts when multiple users change the\nnamed ports concurrently.",
"format": "byte",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this instance group, generated\nby the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#instanceGroup",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#instanceGroup for instance groups.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceGroups.insert"
]
},
"description": "The name of the instance group. The name must be 1-63 characters\nlong, and comply withRFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"namedPorts": {
"description": "Optional. Assigns a name to a port number. For example:{name: \"http\", port: 80}\n\nThis\nallows the system to reference ports by the assigned name instead of a\nport number. Named ports can also contain multiple ports. For example:[{name: \"app1\", port: 8080}, {name:\n\"app1\", port: 8081}, {name: \"app2\", port:\n8082}]\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\ninstance group belong. If your instance has multiple network interfaces,\nthen the network and subnetwork fields only refer to the\nnetwork and subnet used by your primary interface (nic0).",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] The URL of theregion\nwhere the instance group is located (for regional resources).",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] The URL for this instance group. The server generates\nthis URL.",
"readOnly": true,
"type": "string"
},
"size": {
"description": "Output only. [Output Only] The total number of instances in the instance group.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"subnetwork": {
"description": "Output only. [Output Only] The URL of the subnetwork to which all instances in the\ninstance group belong. If your instance has multiple network interfaces,\nthen the network and subnetwork fields only refer to the\nnetwork and subnet used by your primary interface (nic0).",
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] The URL of thezone\nwhere the instance group is located (for zonal resources).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupAggregatedList": {
"id": "InstanceGroupAggregatedList",
"properties": {
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"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. [Output Only] The resource type, which is alwayscompute#instanceGroupAggregatedList for aggregated lists of\ninstance groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupList": {
"description": "A list of InstanceGroup resources.",
"id": "InstanceGroupList",
"properties": {
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of InstanceGroup resources.",
"items": {
"$ref": "InstanceGroup"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupList",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupList for instance group lists.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"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\nsingle entity. For more information, readInstance groups.\n\nFor zonal Managed Instance Group, use the instanceGroupManagers\nresource.\n\nFor regional Managed Instance Group, use theregionInstanceGroupManagers resource.",
"id": "InstanceGroupManager",
"properties": {
"allInstancesConfig": {
"$ref": "InstanceGroupManagerAllInstancesConfig",
"description": "Specifies configuration that overrides the instance template configuration\nfor the group."
},
"autoHealingPolicies": {
"description": "The autohealing policy for this managed instance group. You can specify\nonly one value.",
"items": {
"$ref": "InstanceGroupManagerAutoHealingPolicy"
},
"type": "array"
},
"baseInstanceName": {
"description": "The base instance name is a prefix that you want to attach to the names of\nall VMs in a MIG. The maximum character length is 58 and the name must\ncomply with RFC1035 format.\n\nWhen a VM is created in the group, the MIG appends a hyphen and a random\nfour-character string to the base instance name. If you want the MIG to\nassign sequential numbers instead of a random string, then end the base\ninstance name with a hyphen followed by one or more hash symbols. The hash\nsymbols indicate the number of digits. For example, a base instance name of\n\"vm-###\" results in \"vm-001\" as a VM name.\n@pattern\n[a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,51}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))",
"type": "string"
},
"creationTimestamp": {
"description": "Output only. The creation timestamp for this managed instance group inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"currentActions": {
"$ref": "InstanceGroupManagerActionsSummary",
"description": "Output only. The list of instance actions and the number of instances\nin this managed instance group that are scheduled for each of those\nactions.",
"readOnly": true
},
"description": {
"description": "An optional description of this resource.",
"type": "string"
},
"distributionPolicy": {
"$ref": "DistributionPolicy",
"description": "Policy specifying the intended distribution of managed instances across\nzones in a regional managed instance group."
},
"fingerprint": {
"description": "Fingerprint of this resource. This field may be used in optimistic locking.\nIt will be ignored when inserting an InstanceGroupManager. An up-to-date\nfingerprint must be provided in order to update the InstanceGroupManager,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InstanceGroupManager.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. A unique identifier for this resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceFlexibilityPolicy": {
"$ref": "InstanceGroupManagerInstanceFlexibilityPolicy",
"description": "Instance flexibility allowing MIG to create VMs from multiple\ntypes of machines.\nInstance flexibility configuration on MIG overrides instance\ntemplate configuration."
},
"instanceGroup": {
"description": "Output only. The URL of the Instance Group resource.",
"readOnly": true,
"type": "string"
},
"instanceLifecyclePolicy": {
"$ref": "InstanceGroupManagerInstanceLifecyclePolicy",
"description": "The repair policy for this managed instance group."
},
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed\ninstance group. The group uses this template to create all new instances\nin the managed instance group. The templates for existing instances in the\ngroup do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.",
"type": "string"
},
"kind": {
"default": "compute#instanceGroupManager",
"description": "Output only. The resource type, which is alwayscompute#instanceGroupManager for managed instance groups.",
"readOnly": true,
"type": "string"
},
"listManagedInstancesResults": {
"description": "Pagination behavior of the listManagedInstances API method for\nthis managed instance group.",
"enum": [
"PAGELESS",
"PAGINATED"
],
"enumDescriptions": [
"(Default) Pagination is disabled for the group'slistManagedInstances API method. maxResults\nand pageToken query parameters are ignored and all\ninstances are returned in a single response.",
"Pagination is enabled for the group's listManagedInstances\nAPI method. maxResults and pageToken query\nparameters are respected."
],
"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\nlong, and comply withRFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"namedPorts": {
"description": "[Output Only] Named ports configured on the Instance Groups complementary\nto this Instance Group Manager.",
"items": {
"$ref": "NamedPort"
},
"type": "array"
},
"region": {
"description": "Output only. [Output Only] The URL of theregion\nwhere the managed instance group resides (for regional resources).",
"readOnly": true,
"type": "string"
},
"resourcePolicies": {
"$ref": "InstanceGroupManagerResourcePolicies",
"description": "Resource policies for this managed instance group."
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. The URL for this managed instance group. The server defines\nthis URL.",
"readOnly": true,
"type": "string"
},
"standbyPolicy": {
"$ref": "InstanceGroupManagerStandbyPolicy",
"description": "Standby policy for stopped and suspended instances."
},
"statefulPolicy": {
"$ref": "StatefulPolicy",
"description": "Stateful configuration for this Instanced Group Manager"
},
"status": {
"$ref": "InstanceGroupManagerStatus",
"description": "Output only. The status of this managed instance group.",
"readOnly": true
},
"targetPools": {
"description": "The URLs for all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically\napply 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.\nYou can reduce this number by using the instanceGroupManager\ndeleteInstances or abandonInstances methods. Resizing the group also\nchanges this number.",
"format": "int32",
"type": "integer"
},
"targetSizePolicy": {
"$ref": "InstanceGroupManagerTargetSizePolicy",
"description": "The policy that specifies how the MIG creates its VMs to achieve the target\nsize."
},
"targetStoppedSize": {
"description": "The target number of stopped instances for this managed instance group.\nThis number changes when you: \n   \n   - Stop instance using the stopInstances\n   method or start instances using the startInstances\n   method.\n   - Manually change the targetStoppedSize using the update\n   method.",
"format": "int32",
"type": "integer"
},
"targetSuspendedSize": {
"description": "The target number of suspended instances for this managed instance group.\nThis number changes when you: \n   \n   - Suspend instance using the suspendInstances\n   method or resume instances using the resumeInstances\n   method.\n   - Manually change the targetSuspendedSize using the update\n   method.",
"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\ncreate instances.\n\nEach version is defined by an instanceTemplate and aname. Every version can appear at most once per instance\ngroup. This field overrides the top-level instanceTemplate\nfield. Read more about therelationships\nbetween these fields. Exactly one version must leave thetargetSize field unset. That version will be applied to all\nremaining instances. For more information, read aboutcanary\nupdates.",
"items": {
"$ref": "InstanceGroupManagerVersion"
},
"type": "array"
},
"zone": {
"description": "Output only. The URL of azone\nwhere the managed instance group is located (for zonal resources).",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerActionsSummary": {
"id": "InstanceGroupManagerActionsSummary",
"properties": {
"abandoning": {
"description": "Output only. The total number of instances in the managed instance group\nthat are scheduled to be abandoned. Abandoning an instance removes it\nfrom the managed instance group without deleting it.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"creating": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be created or are currently being created. If the group\nfails to create any of these instances, it tries again until it creates\nthe instance successfully.\n\nIf you have disabled creation retries, this field will not be populated;\ninstead, the creatingWithoutRetries field will be populated.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"creatingWithoutRetries": {
"description": "Output only. The number of instances that the managed instance group\nwill attempt to create. The group attempts to create each instance\nonly once. If the group fails to create any of these instances, it\ndecreases the group's targetSize value accordingly.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"deleting": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be deleted or are currently being deleted.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"none": {
"description": "Output only. The number of instances in the managed instance group that\nare running and have no scheduled actions.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"recreating": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be recreated or are currently being being recreated.\nRecreating an instance deletes the existing root persistent disk\nand creates a new disk from the image that is defined in the\ninstance template.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"refreshing": {
"description": "Output only. The number of instances in the managed instance group that\nare being reconfigured with properties that do not require a restart\nor a recreate action. For example, setting or removing target\npools for the instance.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"restarting": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be restarted or are currently being restarted.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"resuming": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be resumed or are currently being resumed.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"starting": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be started or are currently being started.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"stopping": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be stopped or are currently being stopped.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"suspending": {
"description": "Output only. The number of instances in the managed instance group that\nare scheduled to be suspended or are currently being suspended.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"verifying": {
"description": "Output only. The number of instances in the managed instance group that\nare being verified. See the managedInstances[].currentAction\nproperty in the listManagedInstances method documentation.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerAggregatedList": {
"id": "InstanceGroupManagerAggregatedList",
"properties": {
"id": {
"description": "Output only. Unique identifier for the resource; defined by the server.",
"readOnly": true,
"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 alwayscompute#instanceGroupManagerAggregatedList for an aggregated\nlist of managed instance groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerAllInstancesConfig": {
"id": "InstanceGroupManagerAllInstancesConfig",
"properties": {
"properties": {
"$ref": "InstancePropertiesPatch",
"description": "Properties to set on all instances in the group.\n\nYou can add or modify properties using theinstanceGroupManagers.patch orregionInstanceGroupManagers.patch. After settingallInstancesConfig on the group, you must update the group's\ninstances to apply the configuration. To apply the configuration, set the\ngroup's updatePolicy.type field to use proactive updates or\nuse the applyUpdatesToInstances method."
}
},
"type": "object"
},
"InstanceGroupManagerAutoHealingPolicy": {
"id": "InstanceGroupManagerAutoHealingPolicy",
"properties": {
"healthCheck": {
"description": "The URL for the health check that signals autohealing.",
"type": "string"
},
"initialDelaySec": {
"description": "The initial delay is the number of seconds that a new VM takes to\ninitialize and run its startup script. During a VM's initial delay\nperiod, the MIG ignores unsuccessful health checks because the VM might\nbe in the startup process. This prevents the MIG from prematurely\nrecreating a VM. If the health check receives a healthy response during\nthe initial delay, it indicates that the startup process is complete and\nthe VM is ready. The value of initial delay must be between 0 and 3600\nseconds. The default value is 0.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerInstanceFlexibilityPolicy": {
"id": "InstanceGroupManagerInstanceFlexibilityPolicy",
"properties": {
"instanceSelections": {
"additionalProperties": {
"$ref": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection"
},
"description": "Named instance selections configuring properties that the group will use\nwhen creating new VMs.",
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection": {
"id": "InstanceGroupManagerInstanceFlexibilityPolicyInstanceSelection",
"properties": {
"machineTypes": {
"description": "Full machine-type names, e.g. \"n1-standard-16\".",
"items": {
"type": "string"
},
"type": "array"
},
"rank": {
"description": "Preference of this instance selection. Lower number means higher\npreference. MIG will first try to create a VM based on the machine-type\nwith lowest rank and fallback to next rank based on availability.\nMachine types and instance selections with the same rank have the same\npreference.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerInstanceLifecyclePolicy": {
"id": "InstanceGroupManagerInstanceLifecyclePolicy",
"properties": {
"defaultActionOnFailure": {
"description": "The action that a MIG performs on a failed or an unhealthy VM.\nA VM is marked as unhealthy when the application running on that\nVM fails a health check.\nValid values are \n   \n   - REPAIR (default): MIG automatically repairs a failed or\n   an unhealthy VM by recreating it. For more information, see About\n   repairing VMs in a MIG.\n   - DO_NOTHING: MIG does not repair a failed or an unhealthy\n   VM.",
"enum": [
"DO_NOTHING",
"REPAIR"
],
"enumDescriptions": [
"MIG does not repair a failed or an unhealthy VM.",
"(Default) MIG automatically repairs a failed or an unhealthy\nVM by recreating it. For more information, see About\nrepairing VMs in a MIG."
],
"type": "string"
},
"forceUpdateOnRepair": {
"description": "A bit indicating whether to forcefully apply the group's latest\nconfiguration when repairing a VM. Valid options are:\n\n   \n   \n     -  NO (default): If configuration updates are available, they are not\n     forcefully applied during repair. Instead, configuration updates are\n     applied according to the group's update policy.\n   \n     -  YES: If configuration updates are available, they are applied\n     during repair.",
"enum": [
"NO",
"YES"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"onFailedHealthCheck": {
"description": "The action that a MIG performs on an unhealthy VM. A VM is marked as\nunhealthy when the application running on that VM fails a health check.\nValid values are:\n   \n   - DEFAULT_ACTION (default): MIG uses the same action\n   configured for instanceLifecyclePolicy.defaultActionOnFailure field.\n   - REPAIR: MIG automatically repairs an unhealthy VM by\n   recreating it.\n   - DO_NOTHING: MIG doesn't repair an unhealthy VM.\n   For more information, see \n   About repairing VMs in a MIG.",
"enum": [
"DEFAULT_ACTION",
"DO_NOTHING",
"REPAIR"
],
"enumDescriptions": [
"(Default) MIG uses the same action configured for\ninstanceLifecyclePolicy.defaultActionOnFailure field.",
"MIG doesn't repair an unhealthy VM.",
"MIG automatically repairs an unhealthy VM by recreating it."
],
"type": "string"
}
},
"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.",
"readOnly": true,
"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\nlist of managed instance groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerResizeRequest": {
"description": "InstanceGroupManagerResizeRequest represents a request to create\na number of VMs: either immediately or by queuing the request for the\nspecified time. This resize request is nested under InstanceGroupManager\nand the VMs created by this request are added to the owning\nInstanceGroupManager.",
"id": "InstanceGroupManagerResizeRequest",
"properties": {
"creationTimestamp": {
"description": "Output only. The creation timestamp for this resize request inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource.",
"type": "string"
},
"id": {
"description": "Output only. A unique identifier for this resource type. The server generates this\nidentifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#instanceGroupManagerResizeRequest",
"description": "Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceGroupManagerResizeRequests.insert"
]
},
"description": "The name of this resize request. The name must be 1-63 characters\nlong, and comply withRFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. The URL of a region\nwhere the resize request is located. Populated only for regional resize\nrequests.",
"readOnly": true,
"type": "string"
},
"requestedRunDuration": {
"$ref": "Duration",
"description": "Requested run duration for instances that will be created by this request.\nAt the end of the run duration instance will be deleted."
},
"resizeBy": {
"description": "The number of instances to be created by this resize request. The group's\ntarget size will be increased by this number. This field cannot be used\ntogether with 'instances'.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "Output only. The URL for this resize request. The server defines this URL.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. Current state of the request.",
"enum": [
"ACCEPTED",
"CANCELLED",
"CREATING",
"FAILED",
"STATE_UNSPECIFIED",
"SUCCEEDED"
],
"enumDescriptions": [
"The request was created successfully and was accepted for provisioning\nwhen the capacity becomes available.",
"The request is cancelled.",
"Resize request is being created and may still fail creation.",
"The request failed before or during provisioning. If the request fails\nduring provisioning, any VMs that were created during provisioning are\nrolled back and removed from the MIG.",
"Default value. This value should never be returned.",
"The request succeeded."
],
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "InstanceGroupManagerResizeRequestStatus",
"description": "Output only. Status of the request.",
"readOnly": true
},
"zone": {
"description": "Output only. The URL of a zone\nwhere the resize request is located. Populated only for zonal resize\nrequests.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerResizeRequestStatus": {
"id": "InstanceGroupManagerResizeRequestStatus",
"properties": {
"error": {
"description": "Output only. Fatal errors encountered during the queueing or provisioning phases of\nthe ResizeRequest that caused the transition to the FAILED state.\nContrary to the last_attempt errors, this field is final and errors are\nnever removed from here, as the ResizeRequest is not going to retry.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"lastAttempt": {
"$ref": "InstanceGroupManagerResizeRequestStatusLastAttempt",
"description": "Output only. Information about the last attempt to fulfill the request. The value is\ntemporary since the ResizeRequest can retry, as long as it's still active\nand the last attempt value can either be cleared or replaced with a\ndifferent error. Since ResizeRequest retries infrequently, the value may\nbe stale and no longer show an active problem. The value is cleared when\nResizeRequest transitions to the final state (becomes inactive). If the\nfinal state is FAILED the error describing it will be stored in the\n\"error\" field only.",
"readOnly": true
}
},
"type": "object"
},
"InstanceGroupManagerResizeRequestStatusLastAttempt": {
"id": "InstanceGroupManagerResizeRequestStatusLastAttempt",
"properties": {
"error": {
"description": "Output only. Errors that prevented the ResizeRequest to be fulfilled.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerResizeRequestsListResponse": {
"description": "[Output Only] A list of resize requests.",
"id": "InstanceGroupManagerResizeRequestsListResponse",
"properties": {
"id": {
"description": "Output only. Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of resize request resources.",
"items": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupManagerResizeRequestList",
"description": "Output only. Type of the resource. Alwayscompute#instanceGroupManagerResizeRequestList for\na list of resize requests.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. This token allows you to get the next page of results for list requests.\nIf the number of results is larger than maxResults, use thenextPageToken as a value for the query parameterpageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagerResourcePolicies": {
"id": "InstanceGroupManagerResourcePolicies",
"properties": {
"workloadPolicy": {
"description": "The URL of the workload policy that is specified for this managed\ninstance group.\nIt can be a full or partial URL. For example, the following are\nall valid URLs to a workload policy: \n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/regions/region/resourcePolicies/resourcePolicy\n      - projects/project/regions/region/resourcePolicies/resourcePolicy\n      - regions/region/resourcePolicies/resourcePolicy",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerStandbyPolicy": {
"id": "InstanceGroupManagerStandbyPolicy",
"properties": {
"initialDelaySec": {
"description": "Specifies the number of seconds that the MIG should wait to suspend or\nstop a VM after that VM was created. The initial delay gives the\ninitialization script the time to prepare your VM for a quick scale out.\nThe value of initial delay must be between 0 and 3600 seconds. The\ndefault value is 0.",
"format": "int32",
"type": "integer"
},
"mode": {
"description": "Defines how a MIG resumes or starts VMs from a standby pool when the\ngroup scales out. The default mode is `MANUAL`.",
"enum": [
"MANUAL",
"SCALE_OUT_POOL"
],
"enumDescriptions": [
"MIG does not automatically resume or start VMs in the standby pool when\nthe group scales out.",
"MIG automatically resumes or starts VMs in the standby pool when the\ngroup scales out, and replenishes the standby pool afterwards."
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerStatus": {
"id": "InstanceGroupManagerStatus",
"properties": {
"allInstancesConfig": {
"$ref": "InstanceGroupManagerStatusAllInstancesConfig",
"description": "Output only. Status of all-instances configuration on the group.",
"readOnly": true
},
"appliedAcceleratorTopologies": {
"description": "Output only. The accelerator topology applied to this MIG.\nCurrently only one accelerator topology is supported.",
"items": {
"$ref": "InstanceGroupManagerStatusAcceleratorTopology"
},
"readOnly": true,
"type": "array"
},
"autoscaler": {
"description": "Output only. The URL of theAutoscaler\nthat targets this instance group manager.",
"readOnly": true,
"type": "string"
},
"bulkInstanceOperation": {
"$ref": "InstanceGroupManagerStatusBulkInstanceOperation",
"description": "Output only. The status of bulk instance operation.",
"readOnly": true
},
"currentInstanceStatuses": {
"$ref": "InstanceGroupManagerStatusInstanceStatusSummary",
"description": "Output only. The list of instance statuses and the number of instances\nin this managed instance group that have the status. Currently only shown\nfor TPU MIGs",
"readOnly": true
},
"isStable": {
"description": "Output only. A bit indicating whether the managed instance group is in a\nstable state. A stable state means that: none of the instances in the\nmanaged instance group is currently undergoing any type of change (for\nexample, creation, restart, or deletion); no future changes are scheduled\nfor instances in the managed instance group; and the managed instance\ngroup itself is not being modified.",
"readOnly": true,
"type": "boolean"
},
"stateful": {
"$ref": "InstanceGroupManagerStatusStateful",
"description": "Output only. Stateful status of the given Instance Group Manager.",
"readOnly": true
},
"versionTarget": {
"$ref": "InstanceGroupManagerStatusVersionTarget",
"description": "Output only. A status of consistency of Instances' versions with their\ntarget version specified by version field on Instance Group\nManager.",
"readOnly": true
}
},
"type": "object"
},
"InstanceGroupManagerStatusAcceleratorTopology": {
"id": "InstanceGroupManagerStatusAcceleratorTopology",
"properties": {
"acceleratorTopology": {
"description": "Output only. Topology in the format of: \"16x16\", \"4x4x4\", etc.\nThe value is the same as configured in the WorkloadPolicy.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of the accelerator topology.",
"enum": [
"ACTIVATING",
"ACTIVE",
"DEACTIVATING",
"FAILED",
"INCOMPLETE",
"REACTIVATING"
],
"enumDescriptions": [
"The accelerator topology is being activated.",
"The accelerator topology is active.",
"The accelerator topology is being deactivated.",
"The accelerator topology failed.",
"The configuration is incomplete and the accelerator topology cannot\nbe activated due to insufficient number of running VMs.",
"The accelerator topology is being reactivated."
],
"readOnly": true,
"type": "string"
},
"stateDetails": {
"$ref": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails",
"description": "Output only. The result of the latest accelerator topology state\ncheck.",
"readOnly": true
}
},
"type": "object"
},
"InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails": {
"id": "InstanceGroupManagerStatusAcceleratorTopologyAcceleratorTopologyStateDetails",
"properties": {
"error": {
"description": "Output only. Encountered errors.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"timestamp": {
"description": "Output only. Timestamp is shown only if there is an error. The field\nhas // RFC3339 //\ntext format.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerStatusAllInstancesConfig": {
"id": "InstanceGroupManagerStatusAllInstancesConfig",
"properties": {
"currentRevision": {
"description": "Output only. Current all-instances configuration revision.\nThis value is in RFC3339 text format.",
"readOnly": true,
"type": "string"
},
"effective": {
"description": "Output only. A bit indicating whether this configuration has\nbeen applied to all managed instances in the group.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"InstanceGroupManagerStatusBulkInstanceOperation": {
"description": "Bulk instance operation is the creation of VMs in a MIG when the\ntargetSizePolicy.mode is set to BULK.",
"id": "InstanceGroupManagerStatusBulkInstanceOperation",
"properties": {
"inProgress": {
"description": "Output only. Informs whether bulk instance operation is in progress.",
"readOnly": true,
"type": "boolean"
},
"lastProgressCheck": {
"$ref": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck",
"description": "Output only. Information from the last progress check of bulk instance\noperation.",
"readOnly": true
}
},
"type": "object"
},
"InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck": {
"id": "InstanceGroupManagerStatusBulkInstanceOperationLastProgressCheck",
"properties": {
"error": {
"description": "Output only. Errors encountered during bulk instance operation.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
},
"timestamp": {
"description": "Output only. Timestamp of the last progress check of bulk instance\noperation. Timestamp is in RFC3339 text format.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerStatusInstanceStatusSummary": {
"description": "The list of instance statuses and the number of instances in this managed\ninstance group that have the status. For more information about how to\ninterpret each status check the instance lifecycle documentation.\nCurrently only shown for TPU MIGs.",
"id": "InstanceGroupManagerStatusInstanceStatusSummary",
"properties": {
"deprovisioning": {
"description": "Output only. The number of instances in the managed instance group\nthat have DEPROVISIONING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nonExistent": {
"description": "Output only. The number of instances that have not been created yet or\nhave been deleted. Includes only instances that would be shown in the\nlistManagedInstances method and not all instances that have been\ndeleted in the lifetime of the MIG.\nDoes not include FlexStart instances that are waiting for the resources\navailability, they are considered as 'pending'.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"pending": {
"description": "Output only. The number of instances in the managed instance group\nthat have PENDING status, that is FlexStart instances that are waiting\nfor resources. Instances that do not exist because of the other reasons\nare counted as 'non_existent'.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"pendingStop": {
"description": "Output only. The number of instances in the managed instance group\nthat have PENDING_STOP status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"provisioning": {
"description": "Output only. The number of instances in the managed instance group\nthat have PROVISIONING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"repairing": {
"description": "Output only. The number of instances in the managed instance group\nthat have REPAIRING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"running": {
"description": "Output only. The number of instances in the managed instance group\nthat have RUNNING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"staging": {
"description": "Output only. The number of instances in the managed instance group\nthat have STAGING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"stopped": {
"description": "Output only. The number of instances in the managed instance group\nthat have STOPPED status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"stopping": {
"description": "Output only. The number of instances in the managed instance group\nthat have STOPPING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"suspended": {
"description": "Output only. The number of instances in the managed instance group\nthat have SUSPENDED status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"suspending": {
"description": "Output only. The number of instances in the managed instance group\nthat have SUSPENDING status.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"terminated": {
"description": "Output only. The number of instances in the managed instance group\nthat have TERMINATED status.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"InstanceGroupManagerStatusStateful": {
"id": "InstanceGroupManagerStatusStateful",
"properties": {
"hasStatefulConfig": {
"description": "Output only. A bit indicating whether the managed instance group\nhas stateful configuration, that is, if you have configured any items\nin a stateful policy or in per-instance configs.\nThe group might report that it has no stateful configuration even when\nthere is still some preserved state on a managed instance, for example,\nif you have deleted all PICs but not yet applied those deletions.",
"readOnly": true,
"type": "boolean"
},
"perInstanceConfigs": {
"$ref": "InstanceGroupManagerStatusStatefulPerInstanceConfigs",
"description": "Output only. Status of per-instance configurations on the instances.",
"readOnly": true
}
},
"type": "object"
},
"InstanceGroupManagerStatusStatefulPerInstanceConfigs": {
"id": "InstanceGroupManagerStatusStatefulPerInstanceConfigs",
"properties": {
"allEffective": {
"description": "Output only. A bit indicating if all of the group's per-instance configurations\n(listed in the output of a listPerInstanceConfigs API call) have\nstatus EFFECTIVE or there are no per-instance-configs.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"InstanceGroupManagerStatusVersionTarget": {
"id": "InstanceGroupManagerStatusVersionTarget",
"properties": {
"isReached": {
"description": "Output only. A bit indicating whether version target has been reached\nin this managed instance group, i.e. all instances are in their target\nversion. Instances' target version are specified byversion field on Instance Group Manager.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"InstanceGroupManagerTargetSizePolicy": {
"id": "InstanceGroupManagerTargetSizePolicy",
"properties": {
"mode": {
"description": "The mode of target size policy based on which the MIG creates its VMs\nindividually or all at once.",
"enum": [
"BULK",
"INDIVIDUAL",
"UNSPECIFIED_MODE"
],
"enumDescriptions": [
"The mode in which the MIG creates VMs all at once. In this mode, if the\nMIG is unable to create even one VM, the MIG waits until all VMs can be\ncreated at the same time.",
"The mode in which the MIG creates VMs individually. In this mode, if\nthe MIG is unable to create a VM, the MIG will continue to create the\nother VMs in the group. This is the default mode.",
"If mode is unspecified, MIG will behave as in the default `INDIVIDUAL`\nmode."
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerUpdatePolicy": {
"id": "InstanceGroupManagerUpdatePolicy",
"properties": {
"instanceRedistributionType": {
"description": "The \ninstance redistribution policy for regional managed instance groups.\nValid values are: \n   \n   - PROACTIVE (default): The group attempts to maintain an\n   even distribution of VM instances across zones in the region.\n   - NONE: For non-autoscaled groups, proactive\n   redistribution is disabled.",
"enum": [
"NONE",
"PROACTIVE"
],
"enumDescriptions": [
"No action is being proactively performed in order to bring this IGM\nto its target instance distribution.",
"This IGM will actively converge to its target instance distribution."
],
"type": "string"
},
"maxSurge": {
"$ref": "FixedOrPercent",
"description": "The maximum number of instances that can be created above the specifiedtargetSize during the update process. This value can be\neither a fixed number or, if the group has 10 or more instances, a\npercentage. If you set a percentage, the number of instances is rounded\nif necessary.  The default value for maxSurge is a fixed\nvalue equal to the number of zones in which the managed instance group\noperates.\n\nAt least one of either maxSurge ormaxUnavailable 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\nprocess. An instance is considered available if all of the following\nconditions are satisfied:\n\n   \n   \n     - The instance's status is\n     RUNNING. \n   - If there is a health\n     check on the instance group, the instance's health check status\n     must be HEALTHY at least once. If there is no health check\n     on the group, then the instance only needs to have a status of\n     RUNNING to be considered available.\n\n\nThis value can be either a fixed number or, if the group has 10 or more\ninstances, a percentage. If you set a percentage, the number of instances\nis rounded if necessary. The default value formaxUnavailable is a fixed value equal to the number of zones\nin which the managed instance group operates.\n\nAt least one of either maxSurge ormaxUnavailable must be greater than 0. Learn more about maxUnavailable."
},
"minimalAction": {
"description": "Minimal action to be taken on an instance. Use this option to minimize\ndisruption as much as possible or to apply a more disruptive action than\nis necessary.\n   \n   - To limit disruption as much as possible, set the minimal action toREFRESH. If your update requires a more disruptive action,\n   Compute Engine performs the necessary action to execute the update.\n   - To apply a more disruptive action than is strictly necessary, set the\n   minimal action to RESTART or REPLACE. For\n   example, Compute Engine does not need to restart a VM to change its\n   metadata. But if your application reads instance metadata only when a VM\n   is restarted, you can set the minimal action to RESTART in\n   order to pick up metadata changes.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "Most disruptive action that is allowed to be taken on an instance.\nYou can specify either NONE to forbid any actions,REFRESH to avoid restarting the VM and to limit disruption\nas much as possible. RESTART to allow actions that can be\napplied without instance replacing or REPLACE to allow all\npossible actions. If the Updater determines that the minimal update\naction needed is more disruptive than most disruptive allowed action you\nspecify it will not perform the update at all.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"type": "string"
},
"replacementMethod": {
"description": "What action should be used to replace instances.\nSee minimal_action.REPLACE",
"enum": [
"RECREATE",
"SUBSTITUTE"
],
"enumDescriptions": [
"Instances will be recreated (with the same name)",
"Default option: instances will be deleted and created (with a new name)"
],
"type": "string"
},
"type": {
"description": "The type\nof update process. You can specify either PROACTIVE so\nthat the MIG automatically updates VMs to the latest configurations orOPPORTUNISTIC so that you can select the VMs that you want\nto update.",
"enum": [
"OPPORTUNISTIC",
"PROACTIVE"
],
"enumDescriptions": [
"MIG will apply new configurations\nto existing VMs only when you selectively target specific or all VMs to\nbe updated.",
"MIG will automatically apply new configurations\nto all or a subset of existing VMs and also to new VMs that are added\nto the group."
],
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagerVersion": {
"id": "InstanceGroupManagerVersion",
"properties": {
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed\ninstance group. The group uses this template to create new instances in\nthe managed instance group until the `targetSize` for this version is\nreached. The templates for existing instances in the group do not change\nunless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE; in those cases,\nexisting instances are updated until the `targetSize` for this version is\nreached.",
"type": "string"
},
"name": {
"description": "Name of the version. Unique among all versions in the scope of this\nmanaged instance group.",
"type": "string"
},
"targetSize": {
"$ref": "FixedOrPercent",
"description": "Specifies the intended number of instances to be created from theinstanceTemplate. The final number of instances created\nfrom the template will be equal to:\n   \n   \n     - If expressed as a fixed number, the minimum of either\n      targetSize.fixed or\n      instanceGroupManager.targetSize is used.\n     - if expressed as a percent, the targetSize\n     would be (targetSize.percent/100 *\n     InstanceGroupManager.targetSize) If there is a remainder, the\n     number is rounded.\n    \n If unset, this version will update any remaining instances not\nupdated by another version. ReadStarting\na 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\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersApplyUpdatesRequest": {
"description": "InstanceGroupManagers.applyUpdatesToInstances",
"id": "InstanceGroupManagersApplyUpdatesRequest",
"properties": {
"allInstances": {
"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.",
"type": "boolean"
},
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
},
"minimalAction": {
"description": "The minimal action that you want to perform on each instance during the\nupdate:\n   \n   \n     - REPLACE: At minimum, delete the instance and create it\n     again. \n   - RESTART: Stop the instance and start it\n     again. \n   - REFRESH: Do not stop the instance and limit\n     disruption as much as possible. \n   - NONE: Do not\n     disrupt the instance at all.\n\n\nBy default, the minimum action is NONE. If your update\nrequires a more disruptive action than you set with this flag, the\nnecessary action is performed to execute the update.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "The most disruptive action that you want to perform on each instance during\nthe update:\n   \n   \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 and limit disruption\n     as much as possible. \n   - NONE: Do not disrupt the\n     instance at all.\n\n\nBy default, the most disruptive allowed action is REPLACE. If\nyour update requires a more disruptive action than you set with this flag,\nthe update request will fail.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"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\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].\nQueued instances do not have URL and can be deleted only by name.\nOne cannot specify both URLs and names in a single request.",
"items": {
"type": "string"
},
"type": "array"
},
"skipInstancesOnValidationError": {
"description": "Specifies whether the request should proceed despite the inclusion of\ninstances that are not members of the group or that are already in the\nprocess of being deleted or abandoned. If this field is set to `false` and\nsuch an instance is specified in the request, the operation fails. The\noperation always fails if the request contains a malformed instance URL or\na reference to an instance that exists in a zone or region other than the\ngroup's zone or region.",
"type": "boolean"
}
},
"type": "object"
},
"InstanceGroupManagersDeletePerInstanceConfigsReq": {
"description": "InstanceGroupManagers.deletePerInstanceConfigs",
"id": "InstanceGroupManagersDeletePerInstanceConfigsReq",
"properties": {
"names": {
"description": "The list of instance names for which we want to delete per-instance configs\non this managed instance group.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersListErrorsResponse": {
"id": "InstanceGroupManagersListErrorsResponse",
"properties": {
"items": {
"description": "Output only. [Output Only] The list of errors of the managed instance group.",
"items": {
"$ref": "InstanceManagedByIgmError"
},
"readOnly": true,
"type": "array"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersListManagedInstancesResponse": {
"id": "InstanceGroupManagersListManagedInstancesResponse",
"properties": {
"managedInstances": {
"description": "Output only. [Output Only] The list of instances in the managed instance group.",
"items": {
"$ref": "ManagedInstance"
},
"readOnly": true,
"type": "array"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersListPerInstanceConfigsResp": {
"id": "InstanceGroupManagersListPerInstanceConfigsResp",
"properties": {
"items": {
"description": "Output only. [Output Only] The list of PerInstanceConfig.",
"items": {
"$ref": "PerInstanceConfig"
},
"readOnly": true,
"type": "array"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagersPatchPerInstanceConfigsReq": {
"description": "InstanceGroupManagers.patchPerInstanceConfigs",
"id": "InstanceGroupManagersPatchPerInstanceConfigsReq",
"properties": {
"perInstanceConfigs": {
"description": "The list of per-instance configurations to insert or patch on this managed\ninstance group.",
"items": {
"$ref": "PerInstanceConfig"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersRecreateInstancesRequest": {
"id": "InstanceGroupManagersRecreateInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to recreate. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersResumeInstancesRequest": {
"id": "InstanceGroupManagersResumeInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to resume. This can be a full URL or\na 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\nproject and zone.",
"items": {
"$ref": "InstanceGroupManager"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. The warning that replaces the list of managed instance groups when the list\nis empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupManagersSetInstanceTemplateRequest": {
"id": "InstanceGroupManagersSetInstanceTemplateRequest",
"properties": {
"instanceTemplate": {
"description": "The URL of the instance template that is specified for this managed\ninstance group. The group uses this template to create all new instances\nin the managed instance group. The templates for existing instances in the\ngroup do not change unless you run recreateInstances, runapplyUpdatesToInstances, or set the group'supdatePolicy.type to PROACTIVE.",
"type": "string"
}
},
"type": "object"
},
"InstanceGroupManagersSetTargetPoolsRequest": {
"id": "InstanceGroupManagersSetTargetPoolsRequest",
"properties": {
"fingerprint": {
"description": "The fingerprint of the target pools information. Use this optional\nproperty to prevent conflicts when multiple users change the target pools\nsettings concurrently. Obtain the fingerprint with theinstanceGroupManagers.get\nmethod. Then, include the fingerprint in your request to ensure that you\ndo not overwrite changes that were applied from another\nconcurrent request.",
"format": "byte",
"type": "string"
},
"targetPools": {
"description": "The list of target pool URLs that instances in this managed instance group\nbelong to. The managed instance group applies these target pools to all\nof the instances in the group. Existing instances and new instances in the\ngroup all receive these target pool settings.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersStartInstancesRequest": {
"id": "InstanceGroupManagersStartInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to start. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersStopInstancesRequest": {
"id": "InstanceGroupManagersStopInstancesRequest",
"properties": {
"forceStop": {
"description": "If this flag is set to true, the Instance Group Manager will proceed to\nstop the instances, skipping initialization on them.",
"type": "boolean"
},
"instances": {
"description": "The URLs of one or more instances to stop. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersSuspendInstancesRequest": {
"id": "InstanceGroupManagersSuspendInstancesRequest",
"properties": {
"forceSuspend": {
"description": "If this flag is set to true, the Instance Group Manager will proceed to\nsuspend the instances, skipping initialization on them.",
"type": "boolean"
},
"instances": {
"description": "The URLs of one or more instances to suspend. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstanceGroupManagersUpdatePerInstanceConfigsReq": {
"description": "InstanceGroupManagers.updatePerInstanceConfigs",
"id": "InstanceGroupManagersUpdatePerInstanceConfigsReq",
"properties": {
"perInstanceConfigs": {
"description": "The list of per-instance configurations to insert or patch on this managed\ninstance group.",
"items": {
"$ref": "PerInstanceConfig"
},
"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. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of InstanceWithNamedPorts resources.",
"items": {
"$ref": "InstanceWithNamedPorts"
},
"type": "array"
},
"kind": {
"default": "compute#instanceGroupsListInstances",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#instanceGroupsListInstances for the list of instances\nin the specified instance group.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupsListInstancesRequest": {
"id": "InstanceGroupsListInstancesRequest",
"properties": {
"instanceState": {
"description": "A filter for the state of the instances in the instance group. Valid\noptions are ALL or RUNNING. If you do not specify\nthis parameter the list includes all instances regardless of their state.",
"enum": [
"ALL",
"RUNNING"
],
"enumDescriptions": [
"Includes all instances in the generated list regardless of their state.",
"Includes instances in the generated list only if they have a RUNNING\nstate."
],
"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. [Output Only] The list ofinstance\ngroups that are contained in this scope.",
"items": {
"$ref": "InstanceGroup"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. [Output Only] An informational warning that replaces the list of\ninstance groups when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"InstanceGroupsSetNamedPortsRequest": {
"id": "InstanceGroupsSetNamedPortsRequest",
"properties": {
"fingerprint": {
"description": "The fingerprint of the named ports information for this instance group.\nUse this optional property to prevent conflicts when multiple users change\nthe named ports settings concurrently. Obtain the fingerprint with theinstanceGroups.get\nmethod. Then, include the fingerprint in your request to ensure that you\ndo not overwrite changes that were applied from another concurrent request.\nA request with an incorrect fingerprint will fail with error412 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. [Output Only] Type of resource. Always compute#instanceList\nfor lists of Instance resources.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Alwayscompute#instanceListReferrers for lists of Instance referrers.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Contents of the error.",
"readOnly": true
},
"instanceActionDetails": {
"$ref": "InstanceManagedByIgmErrorInstanceActionDetails",
"description": "Output only. [Output Only] Details of the instance action that triggered this error.\nMay be null, if the error was not caused by an action on an instance.\nThis field is optional.",
"readOnly": true
},
"timestamp": {
"description": "Output only. [Output Only] The time that this error occurred.\nThis value is in RFC3339 text format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceManagedByIgmErrorInstanceActionDetails": {
"id": "InstanceManagedByIgmErrorInstanceActionDetails",
"properties": {
"action": {
"description": "Output only. [Output Only] Action that managed instance group was executing on\nthe instance when the error occurred. Possible values:",
"enum": [
"ABANDONING",
"CREATING",
"CREATING_WITHOUT_RETRIES",
"DELETING",
"NONE",
"RECREATING",
"REFRESHING",
"RESTARTING",
"RESUMING",
"STARTING",
"STOPPING",
"SUSPENDING",
"VERIFYING"
],
"enumDescriptions": [
"The managed instance group is abandoning this instance. The instance\nwill be removed from the instance group and from any target pools that\nare associated with this group.",
"The managed instance group is creating this instance. If the group\nfails to create this instance, it will try again until it is\nsuccessful.",
"The managed instance group is attempting to create this instance\nonly once. If the group fails to create this instance, it does\nnot try again and the group's targetSize value is\ndecreased.",
"The managed instance group is permanently deleting this instance.",
"The managed instance group has not scheduled any actions for this\ninstance.",
"The managed instance group is recreating this instance.",
"The managed instance group is applying configuration changes to the\ninstance without stopping it. For example, the group can update the\ntarget pool list for an instance without stopping that instance.",
"The managed instance group is restarting this instance.",
"The managed instance group is resuming this instance.",
"The managed instance group is starting this instance.",
"The managed instance group is stopping this instance.",
"The managed instance group is suspending this instance.",
"The managed instance group is verifying this already created instance.\nVerification happens every time the instance is (re)created or restarted\nand consists of:\n 1. Waiting until health check specified as part of this managed instance\n    group's autohealing policy reports HEALTHY.\n    Note: Applies only if autohealing policy has a health check specified\n 2. Waiting for addition verification steps performed as post-instance\n    creation (subject to future extensions)."
],
"readOnly": true,
"type": "string"
},
"instance": {
"description": "Output only. [Output Only] The URL of the instance.\nThe URL can be set even if the instance has not yet been created.",
"readOnly": true,
"type": "string"
},
"version": {
"$ref": "ManagedInstanceVersion",
"description": "Output only. [Output Only] Version this instance was created from, or was being\ncreated from, but the creation failed. Corresponds to one of the versions\nthat were set on the Instance Group Manager resource at the time this\ninstance was being created.",
"readOnly": true
}
},
"type": "object"
},
"InstanceManagedByIgmErrorManagedInstanceError": {
"id": "InstanceManagedByIgmErrorManagedInstanceError",
"properties": {
"code": {
"description": "Output only. [Output Only] Error code.",
"readOnly": true,
"type": "string"
},
"message": {
"description": "Output only. [Output Only] Error message.",
"readOnly": true,
"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\npartial URL. For example, the following are all valid URLs to a zone:\n   \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.\nFor example, the following are all valid URLs to an instance:\n   \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"
},
"InstanceParams": {
"description": "Additional instance params.",
"id": "InstanceParams",
"properties": {
"requestValidForDuration": {
"$ref": "Duration",
"description": "Relative deadline for waiting for capacity. Relevant only for\nInstances.Insert API."
},
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"InstanceProperties": {
"id": "InstanceProperties",
"properties": {
"advancedMachineFeatures": {
"$ref": "AdvancedMachineFeatures",
"description": "Controls for advanced machine-related behavior features.\nNote that for MachineImage, this is not supported yet."
},
"canIpForward": {
"description": "Enables instances created based on these properties to send packets with\nsource IP addresses other than their own and receive packets with\ndestination IP addresses other than their own. If these instances will be\nused as an IP gateway or it will be set as the next-hop in a Route\nresource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding\ndocumentation for more information.",
"type": "boolean"
},
"confidentialInstanceConfig": {
"$ref": "ConfidentialInstanceConfig",
"description": "Specifies the Confidential Instance options.\nNote that for MachineImage, this is not supported yet."
},
"description": {
"description": "An optional text description for the instances that are created from these\nproperties.",
"type": "string"
},
"disks": {
"description": "An array of disks that are associated with the instances that are created\nfrom these properties.",
"items": {
"$ref": "AttachedDisk"
},
"type": "array"
},
"guestAccelerators": {
"description": "A list of guest accelerator cards' type and count to use for instances\ncreated from these properties.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"keyRevocationActionType": {
"description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and\n\"NONE\". The default value is \"NONE\" if it is not specified.",
"enum": [
"KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
"NONE",
"STOP"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Indicates user chose no operation.",
"Indicates user chose to opt for VM shutdown on key revocation."
],
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to instances that are created from these properties.",
"type": "object"
},
"machineType": {
"annotations": {
"required": [
"compute.instanceTemplates.insert"
]
},
"description": "The machine type to use for instances that are created from these\nproperties.\nThis field only accepts a machine type name, for example `n2-standard-4`.\nIf you use the machine type full or partial URL, for example\n`projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4`,\nthe request will result in an `INTERNAL_ERROR`.",
"type": "string"
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs to assign to instances that are created from\nthese properties. These pairs can consist of custom metadata or predefined\nkeys. SeeProject and\ninstance metadata for more information."
},
"minCpuPlatform": {
"description": "Minimum cpu/platform to be used by instances. The instance may be\nscheduled on the specified or newer cpu/platform. Applicable values are the\nfriendly names of CPU platforms, such asminCpuPlatform: \"Intel Haswell\" orminCpuPlatform: \"Intel Sandy Bridge\". For more\ninformation, read Specifying a\nMinimum CPU Platform.",
"type": "string"
},
"networkInterfaces": {
"description": "An array of network access configurations for this interface.",
"items": {
"$ref": "NetworkInterface"
},
"type": "array"
},
"networkPerformanceConfig": {
"$ref": "NetworkPerformanceConfig",
"description": "Note that for MachineImage, this is not supported yet."
},
"privateIpv6GoogleAccess": {
"description": "The private IPv6 google access type for VMs.\nIf not specified, use  INHERIT_FROM_SUBNETWORK as default.\nNote that for MachineImage, this is not supported yet.",
"enum": [
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE",
"INHERIT_FROM_SUBNETWORK"
],
"enumDescriptions": [
"Bidirectional private IPv6 access to/from Google services. If\nspecified, the subnetwork who is attached to the instance's default network\ninterface will be assigned an internal IPv6 prefix if it doesn't have\nbefore.",
"Outbound private IPv6 access from VMs in this subnet to Google services. If\nspecified, the subnetwork who is attached to the instance's default network\ninterface will be assigned an internal IPv6 prefix if it doesn't have\nbefore.",
"Each network interface inherits PrivateIpv6GoogleAccess from its\nsubnetwork."
],
"type": "string"
},
"reservationAffinity": {
"$ref": "ReservationAffinity",
"description": "Specifies the reservations that instances can consume from.\nNote that for MachineImage, this is not supported yet."
},
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the instance. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
},
"resourcePolicies": {
"description": "Resource policies (names, not URLs) applied to instances created from\nthese properties.\nNote that for MachineImage, this is not supported yet.",
"items": {
"type": "string"
},
"type": "array"
},
"scheduling": {
"$ref": "Scheduling",
"description": "Specifies the scheduling options for the instances that are created from\nthese properties."
},
"serviceAccounts": {
"description": "A list of service accounts with specified scopes. Access tokens for these\nservice accounts are available to the instances that are created from\nthese properties. Use metadata queries to obtain the access tokens for\nthese instances.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
},
"shieldedInstanceConfig": {
"$ref": "ShieldedInstanceConfig",
"description": "Note that for MachineImage, this is not supported yet."
},
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from these\nproperties. The tags identify valid sources or targets for network\nfirewalls. The setTags method can modify this list of tags. Each tag within\nthe list must comply with RFC1035."
},
"workloadIdentityConfig": {
"$ref": "WorkloadIdentityConfig"
}
},
"type": "object"
},
"InstancePropertiesPatch": {
"description": "Represents the change that you want to make to the instance properties.",
"id": "InstancePropertiesPatch",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The label key-value pairs that you want to patch onto the instance.",
"type": "object"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "The metadata key-value pairs that you want to patch onto the instance. For\nmore information, see Project and\ninstance metadata.",
"type": "object"
}
},
"type": "object"
},
"InstanceReference": {
"id": "InstanceReference",
"properties": {
"instance": {
"description": "The URL for a specific instance.\n@required compute.instancegroups.addInstances/removeInstances",
"type": "string"
}
},
"type": "object"
},
"InstanceSettings": {
"description": "Represents a Instance Settings resource. You can use instance settings to\nconfigure default settings for Compute Engine VM instances. For example, you\ncan use it to configure default machine type of Compute Engine VM instances.",
"id": "InstanceSettings",
"properties": {
"fingerprint": {
"description": "Specifies a fingerprint for instance settings, which is essentially a hash\nof the instance settings resource's contents and used for optimistic\nlocking. The fingerprint is initially generated by Compute Engine and\nchanges after every request to modify or update the instance settings\nresource. You must always provide an up-to-date fingerprint hash in order\nto update or change the resource, otherwise the request will fail with\nerror 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve the resource.",
"format": "byte",
"type": "string"
},
"kind": {
"default": "compute#instanceSettings",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#instance_settings for instance settings.",
"readOnly": true,
"type": "string"
},
"metadata": {
"$ref": "InstanceSettingsMetadata",
"description": "The metadata key/value pairs assigned to all the instances in the\ncorresponding scope."
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the resource resides\nYou must specify this field as part of the HTTP request URL. It is not\nsettable as a field in the request body.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceSettingsMetadata": {
"id": "InstanceSettingsMetadata",
"properties": {
"items": {
"additionalProperties": {
"type": "string"
},
"description": "A metadata key/value items map.\nThe total size of all keys and values must be less than 512KB.",
"type": "object"
},
"kind": {
"default": "compute#metadata",
"description": "Output only. [Output Only] Type of the resource. Always compute#metadata\nfor metadata.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstanceTemplate": {
"description": "Represents an Instance Template resource.\n\nGoogle Compute Engine has two Instance Template resources:\n\n* [Global](/compute/docs/reference/rest/v1/instanceTemplates)\n* [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates)\n\nYou can reuse a global instance template in\ndifferent regions whereas you can use a regional instance template in a\nspecified region only. If you want to reduce cross-region dependency or\nachieve data residency, use a regional instance template.\n\nTo create VMs, managed instance groups, and reservations, you can use either\nglobal or regional instance templates.\n\nFor more information, readInstance Templates.",
"id": "InstanceTemplate",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp for this instance template inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this instance template. The server\ndefines this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#instanceTemplate",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#instanceTemplate for instance templates.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instanceTemplates.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe 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."
},
"region": {
"description": "Output only. [Output Only] URL of the region where the instance template resides. Only\napplicable for regional resources.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] The URL for this instance template. The server defines this\nURL.",
"readOnly": true,
"type": "string"
},
"sourceInstance": {
"description": "The source instance used to create the template. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n   \n   \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"
},
"InstanceTemplateAggregatedList": {
"description": "Contains a list of InstanceTemplatesScopedList.",
"id": "InstanceTemplateAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InstanceTemplatesScopedList",
"description": "The name of the scope that contains this set of instance templates."
},
"description": "A list of InstanceTemplatesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#instanceTemplateAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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. [Output Only] The resource type, which is alwayscompute#instanceTemplatesListResponse for instance template\nlists.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InstanceTemplatesScopedList": {
"id": "InstanceTemplatesScopedList",
"properties": {
"instanceTemplates": {
"description": "[Output Only] A list of instance templates that are contained within\nthe specified project and zone.",
"items": {
"$ref": "InstanceTemplate"
},
"type": "array"
},
"warning": {
"description": "[Output Only] An informational warning that replaces the list of instance\ntemplates when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] The URL of the instance.",
"readOnly": true,
"type": "string"
},
"namedPorts": {
"description": "Output only. [Output Only] The named ports that belong to this instance group.",
"items": {
"$ref": "NamedPort"
},
"readOnly": true,
"type": "array"
},
"status": {
"description": "Output only. [Output Only] The status of the instance.",
"enum": [
"DEPROVISIONING",
"PENDING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.",
"For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).",
"Resources are being allocated for the instance.",
"The instance is in repair.",
"The instance is running.",
"All required resources have been allocated and the instance\nis being started.",
"The instance has stopped successfully.",
"The instance is currently stopping (either being deleted or killed).",
"The instance has suspended.",
"The instance is suspending.",
"The instance has stopped (either by explicit action or underlying\nfailure)."
],
"readOnly": true,
"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"
},
"InstancesBulkInsertOperationMetadata": {
"id": "InstancesBulkInsertOperationMetadata",
"properties": {
"perLocationStatus": {
"additionalProperties": {
"$ref": "BulkInsertOperationStatus"
},
"description": "Status information per location (location name is key).\nExample key: zones/us-central1-a",
"type": "object"
}
},
"type": "object"
},
"InstancesGetEffectiveFirewallsResponse": {
"id": "InstancesGetEffectiveFirewallsResponse",
"properties": {
"firewallPolicys": {
"description": "[Output Only] Effective firewalls from firewall policies.",
"items": {
"$ref": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
},
"type": "array"
},
"firewalls": {
"description": "Effective firewalls on the instance.",
"items": {
"$ref": "Firewall"
},
"type": "array"
}
},
"type": "object"
},
"InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
"id": "InstancesGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
"properties": {
"displayName": {
"deprecated": true,
"description": "Output only. [Output Only] Deprecated, please use short name instead. The display name\nof the firewall policy.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"packetMirroringRules": {
"description": "Output only. [Output Only] The packet mirroring rules that apply to the instance.",
"items": {
"$ref": "FirewallPolicyRule"
},
"readOnly": true,
"type": "array"
},
"priority": {
"description": "Output only. [Output only] Priority of firewall policy association. Not applicable for\ntype=HIERARCHY.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"rules": {
"description": "[Output Only] The rules that apply to the instance. Only rules that\ntarget the specific VM instance are returned if target service accounts\nor target secure tags are specified in the rules.",
"items": {
"$ref": "FirewallPolicyRule"
},
"type": "array"
},
"shortName": {
"description": "Output only. [Output Only] The short name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,\nNETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.",
"enum": [
"HIERARCHY",
"NETWORK",
"NETWORK_REGIONAL",
"SYSTEM_GLOBAL",
"SYSTEM_REGIONAL",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstancesRemoveResourcePoliciesRequest": {
"id": "InstancesRemoveResourcePoliciesRequest",
"properties": {
"resourcePolicies": {
"description": "Resource policies to be removed from this instance.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InstancesReportHostAsFaultyRequest": {
"id": "InstancesReportHostAsFaultyRequest",
"properties": {
"disruptionSchedule": {
"description": "The disruption schedule for the VM. Required field, only allows IMMEDIATE.",
"enum": [
"DISRUPTION_SCHEDULE_UNSPECIFIED",
"FUTURE",
"IMMEDIATE"
],
"enumDescriptions": [
"Not used. Required as per aip/126.",
"Delay disruption for caller control. Will be default soon.",
"Default value. Disrupt the VM immediately."
],
"type": "string"
},
"faultReasons": {
"items": {
"$ref": "InstancesReportHostAsFaultyRequestFaultReason"
},
"type": "array"
}
},
"type": "object"
},
"InstancesReportHostAsFaultyRequestFaultReason": {
"id": "InstancesReportHostAsFaultyRequestFaultReason",
"properties": {
"behavior": {
"enum": [
"BEHAVIOR_UNSPECIFIED",
"CHIP_ERROR",
"PERFORMANCE",
"SILENT_DATA_CORRUPTION",
"UNRECOVERABLE_GPU_ERROR"
],
"enumDescriptions": [
"Public reportable behaviors",
"Any GPU or TPU errors or faults where the accelerator becomes unusable",
"",
"",
"Unrecoverable GPU error identified by an XID"
],
"type": "string"
},
"description": {
"type": "string"
}
},
"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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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,\nused to prevent conflicts. Provide the latest fingerprint value when making\na 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\nmachine 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"
},
"InstancesSetNameRequest": {
"id": "InstancesSetNameRequest",
"properties": {
"currentName": {
"description": "The current name of this resource, used to prevent conflicts. Provide the\nlatest name when making a request to change name.",
"type": "string"
},
"name": {
"description": "The name to be applied to the instance. Needs to be RFC 1035 compliant.",
"type": "string"
}
},
"type": "object"
},
"InstancesSetSecurityPolicyRequest": {
"id": "InstancesSetSecurityPolicyRequest",
"properties": {
"networkInterfaces": {
"description": "The network interfaces that the security policy will be applied to. Network\ninterfaces use the nicN naming format. You can only set a\nsecurity policy for network interfaces with an access config.",
"items": {
"type": "string"
},
"type": "array"
},
"securityPolicy": {
"description": "A full or partial URL to a security policy to add to this instance.\nIf this field is set to an empty string it will remove the associated\nsecurity policy.",
"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 acustomer-supplied\nencryption key.\n\nIn order to start the instance, the disk url and its corresponding key must\nbe provided.\n\nIf the disk is not protected with a customer-supplied encryption key it\nshould not be specified.",
"items": {
"$ref": "CustomerEncryptionKeyProtectedDisk"
},
"type": "array"
}
},
"type": "object"
},
"InstantSnapshot": {
"description": "Represents a InstantSnapshot resource.\n\nYou can use instant snapshots to create disk rollback points quickly..",
"id": "InstantSnapshot",
"properties": {
"architecture": {
"description": "Output only. [Output Only] The architecture of the instant snapshot. Valid values are\nARM64 or X86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"diskSizeGb": {
"description": "Output only. [Output Only] Size of the source disk, specified in GB.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#instantSnapshot",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshot for InstantSnapshot resources.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this InstantSnapshot, which\nis essentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a InstantSnapshot.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this InstantSnapshot. These can be later modified by\nthe setLabels method.\nLabel values may be empty.",
"type": "object"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "InstantSnapshotParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "Output only. [Output Only] URL of the region where the instant snapshot resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"resourceStatus": {
"$ref": "InstantSnapshotResourceStatus",
"description": "Output only. [Output Only] Status information for the instant snapshot resource.",
"readOnly": true
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"sourceDisk": {
"description": "URL of the source disk used to create this instant snapshot.\nNote that the source disk must be in the same zone/region as the\ninstant snapshot to be created. This can be a full or valid partial URL.\nFor example, the following are valid values:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk\n     \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk\n     \n     - \n       projects/project/zones/zone/disks/disk\n     \n     - \n       projects/project/regions/region/disks/disk\n     \n     - \n       zones/zone/disks/disk\n     \n     - \n       regions/region/disks/disk",
"type": "string"
},
"sourceDiskId": {
"description": "Output only. [Output Only] The ID value of the disk used to create this InstantSnapshot.\nThis value may be used to determine whether the InstantSnapshot\nwas taken from the current or a previous instance of a given disk name.",
"readOnly": true,
"type": "string"
},
"sourceInstantSnapshotGroup": {
"description": "Output only. [Output Only] URL of the source instant snapshot this instant snapshot is\npart of. Note that the source instant snapshot group must be in the same\nzone/region as the instant snapshot to be created. This can be a full or\nvalid partial URL.",
"readOnly": true,
"type": "string"
},
"sourceInstantSnapshotGroupId": {
"description": "Output only. [Output Only] The ID value of the source instant snapshot group this\nInstantSnapshot is part of. This value may be used to determine whether the\nInstantSnapshot was created as part of an InstantSnapshotGroup creation.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of the instantSnapshot. This can beCREATING, DELETING, FAILED, orREADY.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"UNAVAILABLE"
],
"enumDescriptions": [
"InstantSnapshot creation is in progress.",
"InstantSnapshot is currently being deleted.",
"InstantSnapshot creation failed.",
"InstantSnapshot has been created successfully.",
"InstantSnapshot is currently unavailable and cannot be used for\nDisk restoration"
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the instant snapshot resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstantSnapshotAggregatedList": {
"id": "InstantSnapshotAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "InstantSnapshotsScopedList",
"description": "[Output Only] Name of the scope containing this set of instantSnapshots."
},
"description": "A list of InstantSnapshotsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#instantSnapshotAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#instantSnapshotAggregatedList for aggregated lists of\ninstantSnapshots.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InstantSnapshotGroup": {
"description": "Represents an InstantSnapshotGroup resource.\n\nAn instant snapshot group is a set of instant snapshots that represents a\npoint in time state of a consistency group.",
"id": "InstantSnapshotGroup",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Optional. An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#instantSnapshotGroup",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#instantSnapshotGroup for InstantSnapshotGroup\nresources.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Identifier. Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the instant snapshot group resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"resourceStatus": {
"$ref": "InstantSnapshotGroupResourceStatus",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"sourceConsistencyGroup": {
"type": "string"
},
"status": {
"description": "Output only. [Output Only]",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"INVALID",
"READY",
"UNKNOWN"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the instant snapshot group resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstantSnapshotGroupParameters": {
"id": "InstantSnapshotGroupParameters",
"properties": {
"sourceInstantSnapshotGroup": {
"description": "The source instant snapshot group used to create disks. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup\n     - projects/project/zones/zone/instantSnapshotGroups/instantSnapshotGroup\n     - zones/zone/instantSnapshotGroups/instantSnapshotGroup",
"type": "string"
}
},
"type": "object"
},
"InstantSnapshotGroupResourceStatus": {
"id": "InstantSnapshotGroupResourceStatus",
"properties": {
"consistencyMembershipResolutionTime": {
"description": "Output only. [Output Only]",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"sourceInfo": {
"$ref": "InstantSnapshotGroupSourceInfo",
"description": "Output only. [Output Only]",
"readOnly": true
}
},
"type": "object"
},
"InstantSnapshotGroupSourceInfo": {
"id": "InstantSnapshotGroupSourceInfo",
"properties": {
"consistencyGroup": {
"readOnly": true,
"type": "string"
},
"consistencyGroupId": {
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InstantSnapshotList": {
"description": "Contains a list of InstantSnapshot resources.",
"id": "InstantSnapshotList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstantSnapshot resources.",
"items": {
"$ref": "InstantSnapshot"
},
"type": "array"
},
"kind": {
"default": "compute#instantSnapshotList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InstantSnapshotParams": {
"description": "Additional instant snapshot params.",
"id": "InstantSnapshotParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the instant snapshot. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"InstantSnapshotResourceStatus": {
"id": "InstantSnapshotResourceStatus",
"properties": {
"storageSizeBytes": {
"description": "[Output Only] The storage size of this instant snapshot.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"InstantSnapshotsScopedList": {
"id": "InstantSnapshotsScopedList",
"properties": {
"instantSnapshots": {
"description": "[Output Only] A list of instantSnapshots contained in this scope.",
"items": {
"$ref": "InstantSnapshot"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of\ninstantSnapshots when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"Int64RangeMatch": {
"description": "HttpRouteRuleMatch criteria for field values that must stay\nwithin 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 Google\nCloud network and your on-premises network. For more information, read the\nDedicated Interconnect Overview.",
"id": "Interconnect",
"properties": {
"aaiEnabled": {
"description": "Enable or disable the application awareness feature on this Cloud\nInterconnect.",
"type": "boolean"
},
"adminEnabled": {
"description": "Administrative status of the interconnect. When this is set to true, the\nInterconnect is functional and can carry traffic.\nWhen set to false, no packets can be carried over the interconnect and\nno BGP routes are exchanged over it. By default, the status is set to true.",
"type": "boolean"
},
"applicationAwareInterconnect": {
"$ref": "InterconnectApplicationAwareInterconnect",
"description": "Configuration information for application awareness on this Cloud\nInterconnect."
},
"availableFeatures": {
"description": "[Output only] List of features available for this Interconnect connection,\nwhich can take one of the following values:\n   \n   - IF_MACSEC: If present, then the Interconnect connection is\n   provisioned on MACsec capable hardware ports. If not present, then the\n   Interconnect connection is provisioned on non-MACsec capable ports. Any\n   attempt to enable MACsec will fail.\n   - IF_CROSS_SITE_NETWORK: If present, then the Interconnect connection is\n   provisioned exclusively for Cross-Site Networking. Any attempt to configure\n   VLAN attachments will fail. If not present, then the Interconnect\n   connection is not provisioned for Cross-Site Networking. Any attempt to use\n   it for Cross-Site Networking will fail.",
"items": {
"enum": [
"IF_CROSS_SITE_NETWORK",
"IF_L2_FORWARDING",
"IF_MACSEC"
],
"enumDescriptions": [
"Cross-Site Networking",
"L2 Interconnect Attachment Forwarding",
"Media Access Control security (MACsec)"
],
"type": "string"
},
"type": "array"
},
"circuitInfos": {
"description": "Output only. [Output Only] A list of CircuitInfo objects, that describe the individual\ncircuits in this LAG.",
"items": {
"$ref": "InterconnectCircuitInfo"
},
"readOnly": true,
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"customerName": {
"description": "Customer name, to put in the Letter of Authorization as the party\nauthorized to request a crossconnect.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"expectedOutages": {
"description": "Output only. [Output Only] A list of outages expected for this Interconnect.",
"items": {
"$ref": "InterconnectOutageNotification"
},
"readOnly": true,
"type": "array"
},
"googleIpAddress": {
"description": "Output only. [Output Only] IP address configured on the Google side of the Interconnect\nlink. This can be used only for ping tests.",
"readOnly": true,
"type": "string"
},
"googleReferenceId": {
"description": "Output only. [Output Only] Google reference ID to be used when raising support tickets\nwith Google or otherwise to debug backend connectivity issues.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"interconnectAttachments": {
"description": "Output only. [Output Only] A list of the URLs of all InterconnectAttachments configured\nto use  this Interconnect.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"interconnectGroups": {
"description": "Output only. [Output Only] URLs of InterconnectGroups that include this Interconnect.\nOrder is arbitrary and items are unique.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"interconnectType": {
"description": "Type of interconnect, which can take one of the following values:\n   \n   - PARTNER: A partner-managed interconnection shared between customers\n   though a partner.\n   - DEDICATED: A dedicated physical interconnection with the\n   customer.\n\n\nNote that a value IT_PRIVATE has been deprecated in favor of DEDICATED.",
"enum": [
"DEDICATED",
"IT_PRIVATE",
"PARTNER"
],
"enumDescriptions": [
"A dedicated physical interconnection with the customer.",
"[Deprecated] A private, physical interconnection with the customer.",
"A partner-managed interconnection shared between customers via partner."
],
"type": "string"
},
"kind": {
"default": "compute#interconnect",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#interconnect for interconnects.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this Interconnect, which\nis essentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an Interconnect.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"linkType": {
"description": "Type of link requested, which can take one of the following values:\n   \n   - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics\n   - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.\n   - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4 optics.\n\n\n Note that this field indicates the speed of each of\nthe links in the bundle, not the speed of the entire bundle.",
"enum": [
"LINK_TYPE_ETHERNET_100G_LR",
"LINK_TYPE_ETHERNET_10G_LR",
"LINK_TYPE_ETHERNET_400G_LR4"
],
"enumDescriptions": [
"100G Ethernet, LR Optics.",
"10G Ethernet, LR Optics.\n[(rate_bps) =  10000000000];",
"400G Ethernet, LR4 Optics."
],
"type": "string"
},
"location": {
"description": "URL of the InterconnectLocation object that represents where this\nconnection is to be provisioned.",
"type": "string"
},
"macsec": {
"$ref": "InterconnectMacsec",
"description": "Configuration that enables Media Access Control security (MACsec) on the\nCloud Interconnect connection between Google and your on-premises router."
},
"macsecEnabled": {
"description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement\nfails if the MACsec object is not specified.",
"type": "boolean"
},
"name": {
"annotations": {
"required": [
"compute.interconnects.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe 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\nnotifications regarding this Interconnect. If specified, this will be used\nfor notifications in addition to all other forms described, such as\nCloud Monitoring logs alerting and Cloud Notifications. This field is\nrequired for users who sign up for Cloud Interconnect using\nworkforce identity federation.",
"type": "string"
},
"operationalStatus": {
"description": "Output only. [Output Only] The current status of this Interconnect's functionality,\nwhich can take one of the following values:\n   \n   - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to\n   use. Attachments may be provisioned on this Interconnect.\n\n- OS_UNPROVISIONED: An Interconnect that has not completed turnup. No\nattachments may be provisioned on this Interconnect.\n- OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal\nmaintenance. No attachments may be provisioned or updated on this\nInterconnect.",
"enum": [
"OS_ACTIVE",
"OS_UNPROVISIONED"
],
"enumDescriptions": [
"The interconnect is valid, turned up, and ready to use. Attachments may\nbe provisioned on this interconnect.",
"The interconnect has not completed turnup. No attachments may be\nprovisioned on this interconnect."
],
"readOnly": true,
"type": "string"
},
"params": {
"$ref": "InterconnectParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"peerIpAddress": {
"description": "Output only. [Output Only] IP address configured on the customer side of the\nInterconnect link. The customer should configure this IP address during\nturnup when prompted by Google NOC. This can be used only for ping tests.",
"readOnly": true,
"type": "string"
},
"provisionedLinkCount": {
"description": "Output only. [Output Only] Number of links actually provisioned in this interconnect.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"remoteLocation": {
"description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the\nlocation outside of Google's network that the interconnect is connected to.",
"type": "string"
},
"requestedFeatures": {
"description": "Optional. This parameter can be provided only with Interconnect INSERT. It\nisn't valid for Interconnect PATCH. List of features requested for this\nInterconnect connection, which can take one of the following values:\n   \n   - IF_MACSEC: If specified, then the connection is created on MACsec\n   capable hardware ports. If not specified, non-MACsec capable ports will\n   also be considered.\n   - IF_CROSS_SITE_NETWORK: If specified, then the connection is created\n   exclusively for Cross-Site Networking. The connection can not be used for\n   Cross-Site Networking unless this feature is specified.",
"items": {
"enum": [
"IF_CROSS_SITE_NETWORK",
"IF_L2_FORWARDING",
"IF_MACSEC"
],
"enumDescriptions": [
"Cross-Site Networking",
"L2 Interconnect Attachment Forwarding",
"Media Access Control security (MACsec)"
],
"type": "string"
},
"type": "array"
},
"requestedLinkCount": {
"description": "Target number of physical links in the link bundle, as requested by the\ncustomer.",
"format": "int32",
"type": "integer"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. [Output Only] The current state of Interconnect functionality, which can\ntake one of the following values:\n   \n   - ACTIVE: The Interconnect is valid, turned up and ready to use.\n   Attachments may be provisioned on this Interconnect.\n   - UNPROVISIONED: The Interconnect has not completed turnup. No\n   attachments may be provisioned on this Interconnect.\n   - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.\n   No attachments may be provisioned or updated on this\n   Interconnect.",
"enum": [
"ACTIVE",
"UNPROVISIONED"
],
"enumDescriptions": [
"The interconnect is valid, turned up, and ready to use. Attachments may\nbe provisioned on this interconnect.",
"The interconnect has not completed turnup. No attachments may be\nprovisioned on this interconnect."
],
"readOnly": true,
"type": "string"
},
"subzone": {
"description": "To be deprecated.",
"enum": [
"SUBZONE_A",
"SUBZONE_B"
],
"enumDescriptions": [
"Subzone A.",
"Subzone B."
],
"type": "string"
},
"wireGroups": {
"description": "Output only. [Output Only] A list of the URLs of all CrossSiteNetwork WireGroups\nconfigured to use this Interconnect. The Interconnect cannot be deleted if\nthis list is non-empty.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectApplicationAwareInterconnect": {
"description": "Configuration information for application awareness on this Cloud\nInterconnect.",
"id": "InterconnectApplicationAwareInterconnect",
"properties": {
"bandwidthPercentagePolicy": {
"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy"
},
"profileDescription": {
"description": "Description for the application awareness profile on this Cloud\nInterconnect.",
"type": "string"
},
"shapeAveragePercentages": {
"description": "Optional field to specify a list of shape average percentages to be\napplied in conjunction with StrictPriorityPolicy or\nBandwidthPercentagePolicy.",
"items": {
"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage"
},
"type": "array"
},
"strictPriorityPolicy": {
"$ref": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy"
}
},
"type": "object"
},
"InterconnectApplicationAwareInterconnectBandwidthPercentage": {
"description": "Specify bandwidth percentages [1-100] for various traffic classes in\nBandwidthPercentagePolicy. The sum of all percentages must equal 100.\nAll traffic classes must have a percentage value specified.",
"id": "InterconnectApplicationAwareInterconnectBandwidthPercentage",
"properties": {
"percentage": {
"description": "Bandwidth percentage for a specific traffic class.",
"format": "uint32",
"type": "integer"
},
"trafficClass": {
"description": "TrafficClass whose bandwidth percentage is being specified.",
"enum": [
"TC1",
"TC2",
"TC3",
"TC4",
"TC5",
"TC6"
],
"enumDescriptions": [
"Traffic Class 1, corresponding to DSCP ranges (0-7) 000xxx.",
"Traffic Class 2, corresponding to DSCP ranges (8-15) 001xxx.",
"Traffic Class 3, corresponding to DSCP ranges (16-23) 010xxx.",
"Traffic Class 4, corresponding to DSCP ranges (24-31) 011xxx.",
"Traffic Class 5, corresponding to DSCP ranges (32-47) 10xxxx.",
"Traffic Class 6, corresponding to DSCP ranges (48-63) 11xxxx."
],
"type": "string"
}
},
"type": "object"
},
"InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy": {
"id": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy",
"properties": {
"bandwidthPercentages": {
"description": "Specify bandwidth percentages for various traffic classes for queuing\ntype Bandwidth Percent.",
"items": {
"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentage"
},
"type": "array"
}
},
"type": "object"
},
"InterconnectApplicationAwareInterconnectStrictPriorityPolicy": {
"description": "Specify configuration for StrictPriorityPolicy.",
"id": "InterconnectApplicationAwareInterconnectStrictPriorityPolicy",
"properties": {},
"type": "object"
},
"InterconnectAttachment": {
"description": "Represents an Interconnect Attachment (VLAN) resource.\n\nYou can use Interconnect attachments (VLANS) to connect your Virtual Private\nCloud networks to your on-premises networks through an Interconnect.\nFor more information, read\nCreating VLAN Attachments.",
"id": "InterconnectAttachment",
"properties": {
"adminEnabled": {
"description": "Determines whether this Attachment will carry packets.\nNot present for PARTNER_PROVIDER.",
"type": "boolean"
},
"attachmentGroup": {
"description": "Output only. [Output Only] URL of the AttachmentGroup that includes this Attachment.",
"readOnly": true,
"type": "string"
},
"bandwidth": {
"description": "Provisioned bandwidth capacity for the interconnect attachment. For\nattachments of type DEDICATED, the user can set the bandwidth.\nFor attachments of type PARTNER, the Google Partner that is operating\nthe interconnect must set the bandwidth.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED,\nand can take one of the following values:\n   \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\n   - BPS_100G: 100 Gbit/s\n   - BPS_400G: 400 Gbit/s",
"enum": [
"BPS_100G",
"BPS_100M",
"BPS_10G",
"BPS_1G",
"BPS_200M",
"BPS_20G",
"BPS_2G",
"BPS_300M",
"BPS_400G",
"BPS_400M",
"BPS_500M",
"BPS_50G",
"BPS_50M",
"BPS_5G"
],
"enumDescriptions": [
"100 Gbit/s",
"100 Mbit/s",
"10 Gbit/s",
"1 Gbit/s",
"200 Mbit/s",
"20 Gbit/s",
"2 Gbit/s",
"300 Mbit/s",
"400 Gbit/s",
"400 Mbit/s",
"500 Mbit/s",
"50 Gbit/s",
"50 Mbit/s",
"5 Gbit/s"
],
"type": "string"
},
"candidateCloudRouterIpAddress": {
"description": "Single IPv4 address + prefix length to be configured on the cloud router\ninterface for this interconnect attachment.\n   \n   - Both candidate_cloud_router_ip_address and\n   candidate_customer_router_ip_address fields must be set or both must be\n   unset.\n   - Prefix length of both candidate_cloud_router_ip_address and\n   candidate_customer_router_ip_address must be the same.\n   - Max prefix length is 31.",
"type": "string"
},
"candidateCloudRouterIpv6Address": {
"description": "Single IPv6 address + prefix length to be configured on the cloud router\ninterface for this interconnect attachment.\n   \n   - Both candidate_cloud_router_ipv6_address and\n   candidate_customer_router_ipv6_address fields must be set or both must be\n   unset.\n   - Prefix length of both candidate_cloud_router_ipv6_address and\n   candidate_customer_router_ipv6_address must be the same.\n   - Max prefix length is 126.",
"type": "string"
},
"candidateCustomerRouterIpAddress": {
"description": "Single IPv4 address + prefix length to be configured on the customer router\ninterface for this interconnect attachment.",
"type": "string"
},
"candidateCustomerRouterIpv6Address": {
"description": "Single IPv6 address + prefix length to be configured on the customer router\ninterface for this interconnect attachment.",
"type": "string"
},
"candidateIpv6Subnets": {
"description": "This field is not available.",
"items": {
"type": "string"
},
"type": "array"
},
"candidateSubnets": {
"description": "Input only. Up to 16 candidate prefixes that can be used to restrict the allocation\nof cloudRouterIpAddress and customerRouterIpAddress for this attachment.\nAll prefixes must be within link-local address space (169.254.0.0/16) and\nmust be /29 or shorter (/28, /27, etc). Google will attempt to select an\nunused /29 from the supplied candidate prefix(es). The request will fail if\nall possible /29s are in use on Google's edge. If not supplied, Google will\nrandomly select an unused /29 from all of link-local space.",
"items": {
"type": "string"
},
"type": "array"
},
"cloudRouterIpAddress": {
"description": "Output only. [Output Only] IPv4 address + prefix length to be configured on Cloud Router\nInterface for this interconnect attachment.",
"readOnly": true,
"type": "string"
},
"cloudRouterIpv6Address": {
"description": "Output only. [Output Only] IPv6 address + prefix length to be configured on Cloud\nRouter Interface for this interconnect attachment.",
"readOnly": true,
"type": "string"
},
"cloudRouterIpv6InterfaceId": {
"description": "This field is not available.",
"type": "string"
},
"configurationConstraints": {
"$ref": "InterconnectAttachmentConfigurationConstraints",
"description": "Output only. [Output Only] Constraints for this attachment, if any. The attachment does\nnot work if these constraints are not met.",
"readOnly": true
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"customerRouterIpAddress": {
"description": "Output only. [Output Only] IPv4 address + prefix length to be configured on the customer\nrouter subinterface for this interconnect attachment.",
"readOnly": true,
"type": "string"
},
"customerRouterIpv6Address": {
"description": "Output only. [Output Only] IPv6 address + prefix length to be configured on the\ncustomer router subinterface for this interconnect attachment.",
"readOnly": true,
"type": "string"
},
"customerRouterIpv6InterfaceId": {
"description": "This field is not available.",
"type": "string"
},
"dataplaneVersion": {
"description": "Output only. [Output Only] Dataplane version for this InterconnectAttachment. This\nfield is only present for Dataplane version 2 and higher. Absence of this\nfield in the API output indicates that the Dataplane is version 1.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"description": {
"description": "An optional description of this resource.",
"type": "string"
},
"edgeAvailabilityDomain": {
"description": "Input only. Desired availability domain for the attachment. Only available for type\nPARTNER, at creation time, and can take one of the following values:\n   \n   - AVAILABILITY_DOMAIN_ANY\n   - AVAILABILITY_DOMAIN_1\n   - AVAILABILITY_DOMAIN_2\n\n\nFor improved reliability, customers should configure a pair of attachments,\none per availability domain. The selected availability domain will be\nprovided to the Partner via the pairing key, so that the provisioned\ncircuit will lie in the specified domain. If not specified, the value will\ndefault to AVAILABILITY_DOMAIN_ANY.",
"enum": [
"AVAILABILITY_DOMAIN_1",
"AVAILABILITY_DOMAIN_2",
"AVAILABILITY_DOMAIN_ANY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"encryption": {
"description": "Indicates the user-supplied encryption option of this VLAN attachment\n(interconnectAttachment). Can only be specified at attachment creation\nfor PARTNER or DEDICATED attachments.\nPossible values are:\n   \n   - NONE - This is the default value, which means that the\n   VLAN attachment carries unencrypted traffic. VMs are able to send\n   traffic to, or receive traffic from, such a VLAN attachment.\n   - IPSEC - The VLAN attachment carries only encrypted\n   traffic that is encrypted by an IPsec device, such as an HA VPN gateway or\n   third-party IPsec VPN. VMs cannot directly send traffic to, or receive\n   traffic from, such a VLAN attachment. To use *HA VPN over Cloud\n   Interconnect*, the VLAN attachment must be created with this\n   option.",
"enum": [
"IPSEC",
"NONE"
],
"enumDescriptions": [
"The interconnect attachment will carry only encrypted traffic that is\nencrypted by an IPsec device such as HA VPN gateway;\nVMs cannot directly send traffic to or receive traffic from such an\ninterconnect attachment.  To use HA VPN over Cloud Interconnect,\nthe interconnect attachment must be created with this option.",
"This is the default value, which means the Interconnect Attachment will\ncarry unencrypted traffic. VMs will be able to send traffic to or receive\ntraffic from such interconnect attachment."
],
"type": "string"
},
"googleReferenceId": {
"deprecated": true,
"description": "Output only. [Output Only] Google reference ID, to be used when raising support tickets\nwith Google or otherwise to debug backend connectivity issues.\n[Deprecated] This field is not used.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"interconnect": {
"description": "URL of the underlying Interconnect object that this attachment's traffic\nwill traverse through.",
"type": "string"
},
"ipsecInternalAddresses": {
"description": "A list of URLs of addresses that have been reserved for the VLAN\nattachment. Used only for the VLAN attachment that has the encryption\noption as IPSEC. The addresses must be regional internal IP address ranges.\nWhen creating an HA VPN gateway over the VLAN attachment, if the attachment\nis configured to use a regional internal IP address, then the VPN gateway's\nIP address is allocated from the IP address range specified here. For\nexample, if the HA VPN gateway's interface 0 is paired to this VLAN\nattachment, then a regional internal IP address for the VPN gateway\ninterface 0 will be allocated from the IP address specified for this\nVLAN attachment.\nIf this field is not specified when creating the VLAN attachment, then\nlater on when creating an HA VPN gateway on this VLAN attachment, the HA\nVPN gateway's IP address is allocated from the regional external IP address\npool.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectAttachment",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#interconnectAttachment for interconnect attachments.",
"readOnly": true,
"type": "string"
},
"l2Forwarding": {
"$ref": "InterconnectAttachmentL2Forwarding",
"description": "L2 Interconnect Attachment related config. This field is required if the\ntype is L2_DEDICATED.\n\nThe configuration specifies how VLAN tags (like dot1q, qinq, or dot1ad)\nwithin L2 packets are mapped to the destination appliances IP addresses.\nThe packet is then encapsulated with the appliance IP address and sent to\nthe edge appliance."
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this InterconnectAttachment,\nwhich is essentially a hash of the labels set used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an InterconnectAttachment.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"mtu": {
"description": "Maximum Transmission Unit (MTU), in bytes, of packets passing through this\ninterconnect attachment.\nValid values are 1440, 1460, 1500, and 8896. If not specified,\nthe value will default to 1440.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"operationalStatus": {
"description": "Output only. [Output Only] The current status of whether or not this interconnect\nattachment is functional, which can take one of the following values:\n   \n   - OS_ACTIVE: The attachment has been turned up and is ready to\n   use. \n   - OS_UNPROVISIONED: The attachment is not ready to use yet,\n   because turnup is not complete.",
"enum": [
"OS_ACTIVE",
"OS_UNPROVISIONED"
],
"enumDescriptions": [
"Indicates that attachment has been turned up and is ready to\nuse.",
"Indicates that attachment is not ready to use yet, because\nturnup is not complete."
],
"readOnly": true,
"type": "string"
},
"pairingKey": {
"description": "[Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not\npresent for DEDICATED].\nThe opaque identifier of a PARTNER attachment used to initiate\nprovisioning with a selected partner.\nOf the form \"XXXXX/region/domain\"",
"type": "string"
},
"params": {
"$ref": "InterconnectAttachmentParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"partnerAsn": {
"description": "Optional BGP ASN for the router supplied by a Layer 3 Partner if they\nconfigured BGP on behalf of the customer.\nOutput only for PARTNER type, input only for PARTNER_PROVIDER, not\navailable for DEDICATED.",
"format": "int64",
"type": "string"
},
"partnerMetadata": {
"$ref": "InterconnectAttachmentPartnerMetadata",
"description": "Informational metadata about Partner attachments from Partners to display\nto customers.\nOutput only for PARTNER type, mutable for PARTNER_PROVIDER, not\navailable for DEDICATED."
},
"privateInterconnectInfo": {
"$ref": "InterconnectAttachmentPrivateInfo",
"description": "Output only. [Output Only] Information specific to an InterconnectAttachment.\nThis property is populated if the interconnect that\nthis is attached to is of type DEDICATED.",
"readOnly": true
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional interconnect attachment\nresides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
},
"remoteService": {
"description": "Output only. [Output Only]\nIf the attachment is on a Cross-Cloud Interconnect connection, this field\ncontains the interconnect's remote location service provider. Example\nvalues: \"Amazon Web Services\" \"Microsoft Azure\".\n\nThe field is set only for attachments on Cross-Cloud Interconnect\nconnections. Its value is copied from the InterconnectRemoteLocation\nremoteService field.",
"readOnly": true,
"type": "string"
},
"router": {
"description": "URL of the Cloud Router to be used for dynamic routing. This router must be\nin the same region as this InterconnectAttachment. The\nInterconnectAttachment will automatically connect the Interconnect to the\nnetwork & region within which the Cloud Router is configured.",
"type": "string"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"stackType": {
"description": "The stack type for this interconnect attachment to identify whether the\nIPv6 feature is enabled or not. If not specified, IPV4_ONLY\nwill be used.\n\nThis field can be both set at interconnect attachments creation and\nupdate interconnect attachment operations.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY"
],
"enumDescriptions": [
"The interconnect attachment can have both IPv4 and IPv6 addresses.",
"The interconnect attachment will only be assigned IPv4 addresses."
],
"type": "string"
},
"state": {
"description": "Output only. [Output Only] The current state of this attachment's functionality.\nEnum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE,\nPARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values\nPENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used\nfor only PARTNER and PARTNER_PROVIDER interconnect attachments.\nThis state can take one of the following values:\n   \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\n   is not complete.\n   - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet\n   been configured on the Partner side.\n   - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of\n   provisioning after a PARTNER_PROVIDER attachment was created that\n   references it. \n   - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER\n   attachment that is waiting for a customer to activate it. \n   - DEFUNCT:\n   The attachment was deleted externally and is no longer functional. This\n   could be because the associated Interconnect was removed, or because the\n   other side of a Partner attachment was deleted.",
"enum": [
"ACTIVE",
"DEFUNCT",
"PARTNER_REQUEST_RECEIVED",
"PENDING_CUSTOMER",
"PENDING_PARTNER",
"STATE_UNSPECIFIED",
"UNPROVISIONED"
],
"enumDescriptions": [
"Indicates that attachment has been turned up and is ready to use.",
"The attachment was deleted externally and is no longer functional.\nThis could be because the associated Interconnect was wiped out,\nor because the other side of a Partner attachment was deleted.",
"A PARTNER attachment is in the process of provisioning after a\nPARTNER_PROVIDER attachment was created that references it.",
"PARTNER or PARTNER_PROVIDER attachment that is waiting for the customer\nto activate.",
"A newly created PARTNER attachment that has not yet been configured on\nthe Partner side.",
"",
"Indicates that attachment is not ready to use yet, because turnup is not\ncomplete."
],
"readOnly": true,
"type": "string"
},
"subnetLength": {
"description": "Input only. Length of the IPv4 subnet mask.\nAllowed values:\n   \n   \n    - 29 (default)\n    - 30\n\nThe default value is 29, except for Cross-Cloud Interconnect\nconnections that use an InterconnectRemoteLocation with a\nconstraints.subnetLengthRange.min equal to 30. For example,\nconnections that use an Azure remote location fall into this\ncategory. In these cases, the default value is 30, and requesting\n29 returns an error.\n\nWhere both 29 and 30 are allowed, 29 is preferred, because it gives\nGoogle Cloud Support more debugging visibility.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "The type of interconnect attachment this is, which can take one of the\nfollowing values:\n   \n   - DEDICATED: an attachment to a Dedicated Interconnect.\n   - PARTNER: an attachment to a Partner Interconnect, created by the\n   customer.\n   - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by\n   the partner.\n\n- L2_DEDICATED: a L2 attachment to a Dedicated Interconnect.",
"enum": [
"DEDICATED",
"L2_DEDICATED",
"PARTNER",
"PARTNER_PROVIDER"
],
"enumDescriptions": [
"Attachment to a dedicated interconnect.",
"Attachment to a dedicated interconnect, forwarding L2 packets.",
"Attachment to a partner interconnect, created by the customer.",
"Attachment to a partner interconnect, created by the partner."
],
"type": "string"
},
"vlanTag8021q": {
"description": "The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093.\nOnly 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. [Output Only] Type of resource. Alwayscompute#interconnectAttachmentAggregatedList for aggregated\nlists of interconnect attachments.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InterconnectAttachmentConfigurationConstraints": {
"id": "InterconnectAttachmentConfigurationConstraints",
"properties": {
"bgpMd5": {
"description": "Output only. [Output Only] Whether the attachment's BGP session\nrequires/allows/disallows BGP MD5 authentication. This can take one of\nthe following values: MD5_OPTIONAL, MD5_REQUIRED, MD5_UNSUPPORTED.\n\nFor example, a Cross-Cloud Interconnect connection to a remote cloud\nprovider that requires BGP MD5 authentication has the\ninterconnectRemoteLocation attachment_configuration_constraints.bgp_md5\nfield set to MD5_REQUIRED, and that property is propagated to the\nattachment. Similarly, if BGP MD5 is MD5_UNSUPPORTED, an error is\nreturned if MD5 is requested.",
"enum": [
"MD5_OPTIONAL",
"MD5_REQUIRED",
"MD5_UNSUPPORTED"
],
"enumDescriptions": [
"MD5_OPTIONAL: BGP MD5 authentication is supported and can optionally be\nconfigured.",
"MD5_REQUIRED: BGP MD5 authentication must be configured.",
"MD5_UNSUPPORTED: BGP MD5 authentication must not be configured"
],
"readOnly": true,
"type": "string"
},
"bgpPeerAsnRanges": {
"description": "Output only. [Output Only] List of ASN ranges that the remote location is known to\nsupport. Formatted as an array of inclusive ranges {min: min-value, max:\nmax-value}. For example, [{min: 123, max: 123}, {min: 64512, max: 65534}]\nallows the peer ASN to be 123 or anything in the range 64512-65534.\n\nThis field is only advisory. Although the API accepts other ranges, these\nare the ranges that we recommend.",
"items": {
"$ref": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange": {
"id": "InterconnectAttachmentConfigurationConstraintsBgpPeerASNRange",
"properties": {
"max": {
"format": "uint32",
"type": "integer"
},
"min": {
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectAttachmentGroup": {
"description": "An interconnect attachment group resource allows customers to create,\nanalyze, and expand highly available deployments.",
"id": "InterconnectAttachmentGroup",
"properties": {
"attachments": {
"additionalProperties": {
"$ref": "InterconnectAttachmentGroupAttachment"
},
"description": "Attachments in the AttachmentGroup. Keys are arbitrary user-specified\nstrings. Users are encouraged, but not required, to use their preferred\nformat for resource links as keys.\nNote that there are add-members and remove-members methods in gcloud.\nThe size of this map is limited by an \"Attachments per group\" quota.",
"type": "object"
},
"configured": {
"$ref": "InterconnectAttachmentGroupConfigured",
"readOnly": true
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"etag": {
"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed byAIP 154.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"intent": {
"$ref": "InterconnectAttachmentGroupIntent"
},
"interconnectGroup": {
"description": "The URL of an InterconnectGroup that groups these Attachments'\nInterconnects. Customers do not need to set this unless directed by\nGoogle Support.",
"type": "string"
},
"kind": {
"default": "compute#interconnectAttachmentGroup",
"description": "Output only. [Output Only] Type of the resource. Always\ncompute#interconnectAttachmentGroup.",
"readOnly": true,
"type": "string"
},
"logicalStructure": {
"$ref": "InterconnectAttachmentGroupLogicalStructure",
"readOnly": true
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupAttachment": {
"description": "An Attachment in this AttachmentGroup.",
"id": "InterconnectAttachmentGroupAttachment",
"properties": {
"attachment": {
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupConfigured": {
"description": "[Output Only] The redundancy this group is configured to support. The way a\nuser queries what SLA their Attachment gets is by looking at this field of\nthe Attachment's AttachmentGroup.",
"id": "InterconnectAttachmentGroupConfigured",
"properties": {
"availabilitySla": {
"$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLA",
"readOnly": true
}
},
"type": "object"
},
"InterconnectAttachmentGroupConfiguredAvailabilitySLA": {
"description": "[Output Only] Which SLA this group is configured to support, and why this\ngroup does or does not meet that SLA's requirements.",
"id": "InterconnectAttachmentGroupConfiguredAvailabilitySLA",
"properties": {
"effectiveSla": {
"enum": [
"EFFECTIVE_SLA_UNSPECIFIED",
"NO_SLA",
"PRODUCTION_CRITICAL",
"PRODUCTION_NON_CRITICAL"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"intendedSlaBlockers": {
"items": {
"$ref": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers": {
"description": "[Output Only] Reasons why configuration.availabilitySLA.sla differs from\nintent.availabilitySLA. This list is empty if and only if those are the\nsame.",
"id": "InterconnectAttachmentGroupConfiguredAvailabilitySLAIntendedSlaBlockers",
"properties": {
"attachments": {
"description": "Output only. [Output Only] URLs of any particular Attachments to explain this\nblocker in more detail.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"blockerType": {
"enum": [
"BLOCKER_TYPE_UNSPECIFIED",
"INCOMPATIBLE_METROS",
"INCOMPATIBLE_REGIONS",
"MISSING_GLOBAL_ROUTING",
"NO_ATTACHMENTS",
"NO_ATTACHMENTS_IN_METRO_AND_ZONE",
"OTHER"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"documentationLink": {
"description": "Output only. [Output Only] The url of Google Cloud public documentation explaining\nthis requirement. This is set for every type of requirement.",
"readOnly": true,
"type": "string"
},
"explanation": {
"description": "Output only. [Output Only] A human-readable explanation of this requirement and\nwhy it's not met. This is set for every type of requirement.",
"readOnly": true,
"type": "string"
},
"metros": {
"description": "Output only. [Output Only] Metros used to explain this blocker in more detail.\nThese are three-letter lowercase strings like \"iad\". This will be set\nfor some blockers (like NO_ATTACHMENTS_IN_METRO_AND_ZONE) but does\nnot apply to others.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"regions": {
"description": "Output only. [Output Only] Regions used to explain this blocker in more\ndetail. These are region names formatted like \"us-central1\". This\nwill be set for some blockers (like INCOMPATIBLE_REGIONS) but does\nnot apply to others.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"zones": {
"description": "Output only. [Output Only] Zones used to explain this blocker in more detail.\nFormat is \"zone1\" and/or \"zone2\". This will be set for some blockers\n(like  MISSING_ZONE) but does not apply to others.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentGroupIntent": {
"description": "The user's intent for this AttachmentGroup. This is the only required field\nbesides the name that must be specified on group creation.",
"id": "InterconnectAttachmentGroupIntent",
"properties": {
"availabilitySla": {
"enum": [
"AVAILABILITY_SLA_UNSPECIFIED",
"NO_SLA",
"PRODUCTION_CRITICAL",
"PRODUCTION_NON_CRITICAL"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupLogicalStructure": {
"description": "[Output Only] An analysis of the logical layout of Attachments in this\ngroup. Every Attachment in the group is shown once in this structure.",
"id": "InterconnectAttachmentGroupLogicalStructure",
"properties": {
"regions": {
"items": {
"$ref": "InterconnectAttachmentGroupLogicalStructureRegion"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentGroupLogicalStructureRegion": {
"description": "[Output Only] The regions Attachments in this group are in.",
"id": "InterconnectAttachmentGroupLogicalStructureRegion",
"properties": {
"metros": {
"items": {
"$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetro"
},
"readOnly": true,
"type": "array"
},
"region": {
"description": "Output only. [Output Only] The name of a region, like \"us-central1\".",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupLogicalStructureRegionMetro": {
"description": "[Output Only] The metros of Attachments in this group in this region.",
"id": "InterconnectAttachmentGroupLogicalStructureRegionMetro",
"properties": {
"facilities": {
"items": {
"$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility"
},
"readOnly": true,
"type": "array"
},
"metro": {
"description": "Output only. [Output Only] The name of the metro, as a three-letter lowercase\nstring like \"iad\". This is the first component of the location of an\nInterconnect.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupLogicalStructureRegionMetroFacility": {
"description": "[Output Only] The facilities used for this group's Attachments'\nInterconnects.",
"id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacility",
"properties": {
"facility": {
"description": "Output only. [Output Only] The name of a facility, like \"iad-1234\".",
"readOnly": true,
"type": "string"
},
"zones": {
"items": {
"$ref": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone": {
"description": "[Output Only] The zones that Attachments in this group are present\nin, in the given facilities.  This is inherited from their\nInterconnects.",
"id": "InterconnectAttachmentGroupLogicalStructureRegionMetroFacilityZone",
"properties": {
"attachments": {
"description": "Output only. [Output Only] URLs of Attachments in the given zone, to the given\nregion, on Interconnects in the given facility and metro. Every\nAttachment in the AG has such an entry.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"zone": {
"description": "Output only. [Output Only] The name of a zone, either \"zone1\" or \"zone2\".",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentGroupsGetOperationalStatusResponse": {
"description": "Response for the InterconnectAttachmentGroupsGetOperationalStatusResponse.",
"id": "InterconnectAttachmentGroupsGetOperationalStatusResponse",
"properties": {
"etag": {
"type": "string"
},
"result": {
"$ref": "InterconnectAttachmentGroupsOperationalStatus"
}
},
"type": "object"
},
"InterconnectAttachmentGroupsListResponse": {
"id": "InterconnectAttachmentGroupsListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InterconnectAttachmentGroup resources.",
"items": {
"$ref": "InterconnectAttachmentGroup"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectAttachmentGroup",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface:\nMixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InterconnectAttachmentGroupsOperationalStatus": {
"id": "InterconnectAttachmentGroupsOperationalStatus",
"properties": {
"attachmentStatuses": {
"items": {
"$ref": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus"
},
"readOnly": true,
"type": "array"
},
"configured": {
"$ref": "InterconnectAttachmentGroupConfigured",
"readOnly": true
},
"groupStatus": {
"description": "Output only. Summarizes the status of the group.",
"enum": [
"DEGRADED",
"FULLY_DOWN",
"FULLY_UP",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"intent": {
"$ref": "InterconnectAttachmentGroupIntent",
"readOnly": true
},
"operational": {
"$ref": "InterconnectAttachmentGroupConfigured",
"description": "Output only. The operational state of the group, including only active Attachments.",
"readOnly": true
}
},
"type": "object"
},
"InterconnectAttachmentGroupsOperationalStatusAttachmentStatus": {
"description": "The status of one Attachment in the group. List order is arbitrary.",
"id": "InterconnectAttachmentGroupsOperationalStatusAttachmentStatus",
"properties": {
"adminEnabled": {
"description": "Output only. Whether this Attachment is enabled. This becomes false when the customer\ndrains their Attachment.",
"readOnly": true,
"type": "boolean"
},
"attachment": {
"description": "Output only. The URL of the Attachment being described.",
"readOnly": true,
"type": "string"
},
"isActive": {
"description": "Output only. Whether this Attachment is participating in the redundant configuration.\nThis will be ACTIVE if and only if the status below is CONNECTION_UP.\nAny INACTIVE Attachments are excluded from the analysis that generates\noperational.availabilitySLA.",
"enum": [
"ACTIVE",
"INACTIVE",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. Whether this Attachment is active, and if so, whether BGP is up.",
"enum": [
"ATTACHMENT_STATUS_UNKNOWN",
"CONNECTION_DISABLED",
"CONNECTION_DOWN",
"CONNECTION_UP",
"DEFUNCT",
"IPSEC_CONFIGURATION_NEEDED_STATUS",
"IPSEC_READY_TO_RESUME_FLOW_STATUS",
"IPV4_DOWN_IPV6_UP",
"IPV4_UP_IPV6_DOWN",
"PARTNER_REQUEST_RECEIVED",
"PENDING_CUSTOMER",
"PENDING_PARTNER",
"PROVISIONED",
"ROUTER_CONFIGURATION_BROKEN",
"UNPROVISIONED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentL2Forwarding": {
"description": "L2 Interconnect Attachment related configuration.",
"id": "InterconnectAttachmentL2Forwarding",
"properties": {
"applianceMappings": {
"additionalProperties": {
"$ref": "InterconnectAttachmentL2ForwardingApplianceMapping"
},
"description": "Optional. A map of VLAN tags to appliances and optional inner mapping\nrules. If VLANs are not explicitly mapped to any appliance, the\ndefaultApplianceIpAddress is used.\n\nEach VLAN tag can be a single number or a range of numbers in the range\nof 1 to 4094, e.g., \"1\" or \"4001-4094\". Non-empty and non-overlapping\nVLAN tag ranges are enforced, and violating operations will be rejected.\n\nThe VLAN tags in the Ethernet header must use an ethertype value of\n0x88A8 or 0x8100.",
"type": "object"
},
"defaultApplianceIpAddress": {
"description": "Optional. A single IPv4 or IPv6 address used as the default destination\nIP when there is no VLAN mapping result found.\n\nUnset field (null-value) indicates the unmatched packet should be\ndropped.",
"type": "string"
},
"geneveHeader": {
"$ref": "InterconnectAttachmentL2ForwardingGeneveHeader",
"description": "Optional. It represents the structure of a Geneve (Generic Network\nVirtualization Encapsulation) header, as defined in RFC8926. It encapsulates packets from various\nprotocols (e.g., Ethernet, IPv4, IPv6) for use in network virtualization\nenvironments."
},
"network": {
"description": "Required. Resource URL of the network to which this attachment belongs.",
"type": "string"
},
"tunnelEndpointIpAddress": {
"description": "Required. A single IPv4 or IPv6 address. This address will be used as the\nsource IP address for packets sent to the appliances, and must be used as\nthe destination IP address for packets that should be sent out through\nthis attachment.",
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentL2ForwardingApplianceMapping": {
"description": "Two-level VLAN-to-Appliance mapping rule.",
"id": "InterconnectAttachmentL2ForwardingApplianceMapping",
"properties": {
"applianceIpAddress": {
"description": "Optional. A single IPv4 or IPv6 address used as the destination IP\naddress for ingress packets that match on a VLAN tag, but do not match\na more specific inner VLAN tag.\n\nUnset field (null-value) indicates both VLAN tags are required to be\nmapped. Otherwise, defaultApplianceIpAddress is used.",
"type": "string"
},
"innerVlanToApplianceMappings": {
"description": "Optional. Used to match against the inner VLAN when the packet\ncontains two VLAN tags.\n\nA list of mapping rules from inner VLAN tags to IP addresses. If the\ninner VLAN is not explicitly mapped to an IP address range, the\napplianceIpAddress is used.",
"items": {
"$ref": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping"
},
"type": "array"
},
"name": {
"description": "Optional. The name of this appliance mapping rule.",
"type": "string"
}
},
"type": "object"
},
"InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping": {
"description": "The inner VLAN-to-Appliance mapping.",
"id": "InterconnectAttachmentL2ForwardingApplianceMappingInnerVlanToApplianceMapping",
"properties": {
"innerApplianceIpAddress": {
"description": "Required in this object. A single IPv4 or IPv6 address used as the\ndestination IP address for ingress packets that match on both VLAN\ntags.",
"type": "string"
},
"innerVlanTags": {
"description": "Required in this object. Used to match the inner VLAN tag on the\npacket. Each entry can be a single number or a range of numbers in\nthe range of 1 to 4094, e.g., [\"1\", \"4001-4094\"] is valid. Non-empty\nand Non-overlapping VLAN tag ranges are enforced, and violating\noperations will be rejected.\n\nThe inner VLAN tags must have an ethertype value of 0x8100.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"InterconnectAttachmentL2ForwardingGeneveHeader": {
"description": "GeneveHeader related configurations.",
"id": "InterconnectAttachmentL2ForwardingGeneveHeader",
"properties": {
"vni": {
"description": "Optional. VNI is a 24-bit unique virtual network identifier, from 0 to\n16,777,215.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectAttachmentList": {
"description": "Response to the list request, and contains a list of interconnect\nattachments.",
"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. [Output Only] Type of resource. Alwayscompute#interconnectAttachmentList for lists of interconnect\nattachments.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InterconnectAttachmentParams": {
"description": "Additional interconnect attachment parameters.",
"id": "InterconnectAttachmentParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"InterconnectAttachmentPartnerMetadata": {
"description": "Informational metadata about Partner attachments from Partners to display\nto customers.  These fields are propagated from PARTNER_PROVIDER\nattachments to their corresponding PARTNER attachments.",
"id": "InterconnectAttachmentPartnerMetadata",
"properties": {
"interconnectName": {
"description": "Plain text name of the Interconnect this attachment is connected to, as\ndisplayed in the Partner's portal. For instance \"Chicago 1\".\nThis value may be validated to match approved Partner values.",
"type": "string"
},
"partnerName": {
"description": "Plain text name of the Partner providing this attachment.\nThis 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\nthis to be a deep link to the specific resource on the Partner portal.\nThis 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\ninterconnect of type DEDICATED.",
"id": "InterconnectAttachmentPrivateInfo",
"properties": {
"tag8021q": {
"description": "[Output Only] 802.1q encapsulation tag to be used for traffic between\nGoogle 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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nCircuitInfo objects are created by Google, so all fields are output only.",
"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\nprovided by Google to the customer in the LOA.",
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnostics": {
"description": "Diagnostics information about the Interconnect connection, which contains\ndetailed and current technical information about Google's side of the\nconnection.",
"id": "InterconnectDiagnostics",
"properties": {
"arpCaches": {
"description": "A list of InterconnectDiagnostics.ARPEntry objects,\ndescribing individual neighbors currently seen by the Google router in\nthe ARP cache for the Interconnect.\nThis will be empty when the Interconnect is not bundled.",
"items": {
"$ref": "InterconnectDiagnosticsARPEntry"
},
"type": "array"
},
"bundleAggregationType": {
"description": "The aggregation type of the bundle interface.",
"enum": [
"BUNDLE_AGGREGATION_TYPE_LACP",
"BUNDLE_AGGREGATION_TYPE_STATIC"
],
"enumDescriptions": [
"LACP is enabled.",
"LACP is disabled."
],
"type": "string"
},
"bundleOperationalStatus": {
"description": "The operational status of the bundle interface.",
"enum": [
"BUNDLE_OPERATIONAL_STATUS_DOWN",
"BUNDLE_OPERATIONAL_STATUS_UP"
],
"enumDescriptions": [
"If bundleAggregationType is LACP: LACP is not established and/or all\nlinks in the bundle have DOWN operational status. If\nbundleAggregationType is STATIC: one or more links in the bundle has\nDOWN operational status.",
"If bundleAggregationType is LACP: LACP is established and at least one\nlink in the bundle has UP operational status. If bundleAggregationType\nis STATIC: all links in the bundle (typically just one) have UP\noperational status."
],
"type": "string"
},
"links": {
"description": "A list of InterconnectDiagnostics.LinkStatus objects,\ndescribing 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   \n   - ACTIVE: The link is configured and active within the bundle.\n   - DETACHED: The link is not configured within the bundle. This means\n   that the rest of the object should be empty.",
"enum": [
"ACTIVE",
"DETACHED"
],
"enumDescriptions": [
"The link is configured and active within the bundle.",
"The link is not configured within the bundle, this means the rest of\nthe object should be empty."
],
"type": "string"
}
},
"type": "object"
},
"InterconnectDiagnosticsLinkOpticalPower": {
"id": "InterconnectDiagnosticsLinkOpticalPower",
"properties": {
"state": {
"description": "The status of the current value when compared to the warning and alarm\nlevels for the receiving or transmitting transceiver. Possible states\ninclude:\n   \n   \n    - OK: The value has not crossed a warning threshold.\n    - LOW_WARNING: The value has crossed below the low\n    warning threshold. \n   - HIGH_WARNING: The value has\n    crossed above the high warning threshold.\n    - LOW_ALARM: The value has crossed below the low alarm\n    threshold.\n    - HIGH_ALARM: The value has crossed above the high alarm\n    threshold.",
"enum": [
"HIGH_ALARM",
"HIGH_WARNING",
"LOW_ALARM",
"LOW_WARNING",
"OK"
],
"enumDescriptions": [
"The value has crossed above the high alarm threshold.",
"The value of the current optical power has crossed above the high\nwarning threshold.",
"The value of the current optical power has crossed below the low alarm\nthreshold.",
"The value of the current optical power has crossed below the low\nwarning threshold.",
"The value of the current optical power has not crossed a warning\nthreshold."
],
"type": "string"
},
"value": {
"description": "Value of the current receiving or transmitting optical power, read in\ndBm. Take a known good optical value, give it a 10% margin and trigger\nwarnings relative to that value. In general, a -7dBm warning and a -11dBm\nalarm 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,\ndescribing the ARP neighbor entries seen on this link.\nThis 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"
},
"macsec": {
"$ref": "InterconnectDiagnosticsMacsecStatus",
"description": "Describes the status of MACsec encryption on this link."
},
"operationalStatus": {
"description": "The operational status of the link.",
"enum": [
"LINK_OPERATIONAL_STATUS_DOWN",
"LINK_OPERATIONAL_STATUS_UP"
],
"enumDescriptions": [
"The interface is unable to communicate with the remote end.",
"The interface has low level communication with the remote end."
],
"type": "string"
},
"receivingOpticalPower": {
"$ref": "InterconnectDiagnosticsLinkOpticalPower",
"description": "An InterconnectDiagnostics.LinkOpticalPower object,\ndescribing the current value and status of the received light level."
},
"transmittingOpticalPower": {
"$ref": "InterconnectDiagnosticsLinkOpticalPower",
"description": "An InterconnectDiagnostics.LinkOpticalPower object,\ndescribing the current value and status of the transmitted light level."
}
},
"type": "object"
},
"InterconnectDiagnosticsMacsecStatus": {
"description": "Describes the status of MACsec encryption on the link.",
"id": "InterconnectDiagnosticsMacsecStatus",
"properties": {
"ckn": {
"description": "Indicates the Connectivity Association Key Name (CKN)\ncurrently being used if MACsec is operational.",
"type": "string"
},
"operational": {
"description": "Indicates whether or not MACsec is operational on this link.",
"type": "boolean"
}
},
"type": "object"
},
"InterconnectGroup": {
"description": "An interconnect group resource allows customers to create, analyze, and\nexpand their redundant connections.",
"id": "InterconnectGroup",
"properties": {
"configured": {
"$ref": "InterconnectGroupConfigured",
"readOnly": true
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"etag": {
"description": "Opaque system-generated token that uniquely identifies the configuration.\nIf provided when patching a configuration in update mode, the provided\ntoken must match the current token or the update is rejected. This provides\na reliable means of doing read-modify-write (optimistic locking) as\ndescribed by AIP 154.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"intent": {
"$ref": "InterconnectGroupIntent"
},
"interconnects": {
"additionalProperties": {
"$ref": "InterconnectGroupInterconnect"
},
"description": "Interconnects in the InterconnectGroup. Keys are arbitrary user-specified\nstrings. Users are encouraged, but not required, to use their preferred\nformat for resource links as keys.\nNote that there are add-members and remove-members methods in gcloud.\nThe size of this map is limited by an \"Interconnects per group\" quota.",
"type": "object"
},
"kind": {
"default": "compute#InterconnectGroup",
"description": "Output only. [Output Only] Type of the resource. Always compute#InterconnectGroup",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.interconnectGroups.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"physicalStructure": {
"$ref": "InterconnectGroupPhysicalStructure",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupConfigured": {
"description": "[Output Only] The status of the group as configured. This has the same\nstructure as the operational field reported by the OperationalStatus\nmethod, but does not take into account the operational status of each\nresource.",
"id": "InterconnectGroupConfigured",
"properties": {
"topologyCapability": {
"$ref": "InterconnectGroupConfiguredTopologyCapability",
"readOnly": true
}
},
"type": "object"
},
"InterconnectGroupConfiguredTopologyCapability": {
"description": "[Output Only] How reliable this topology is configured to be, and why\nthis group does or does not meet the requirements for the intended\ncapability.",
"id": "InterconnectGroupConfiguredTopologyCapability",
"properties": {
"intendedCapabilityBlockers": {
"items": {
"$ref": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers"
},
"readOnly": true,
"type": "array"
},
"supportedSla": {
"enum": [
"NO_SLA",
"PRODUCTION_CRITICAL",
"PRODUCTION_NON_CRITICAL",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers": {
"description": "[Output Only] Reasons why configuration.topologyCapability.sla differs\nfrom intent.topologyCapability. This list is empty if and only if those\nare the same.",
"id": "InterconnectGroupConfiguredTopologyCapabilityIntendedCapabilityBlockers",
"properties": {
"blockerType": {
"enum": [
"INCOMPATIBLE_METROS",
"NOT_AVAILABLE",
"NO_INTERCONNECTS",
"NO_INTERCONNECTS_IN_METRO_AND_ZONE",
"OTHER",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"documentationLink": {
"description": "Output only. [Output Only] The url of Google Cloud public documentation explaining\nthis requirement. This is set for every type of requirement.",
"readOnly": true,
"type": "string"
},
"explanation": {
"description": "Output only. [Output Only] A human-readable explanation of this requirement and\nwhy it's not met. This is set for every type of requirement.",
"readOnly": true,
"type": "string"
},
"facilities": {
"description": "Output only. [Output Only] Facilities used to explain this blocker in more detail.\nLike physicalStructure.metros.facilities.facility, this is a numeric\nstring like \"5467\".",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"interconnects": {
"description": "Output only. [Output Only] Interconnects used to explain this blocker in more\ndetail.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"metros": {
"description": "Output only. [Output Only] Metros used to explain this blocker in more detail.\nThese are three-letter lowercase strings like \"iad\". A blocker like\nINCOMPATIBLE_METROS will specify the problematic metros in this\nfield.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"zones": {
"description": "Output only. [Output Only] Zones used to explain this blocker in more detail.\nZone names are \"zone1\" and/or \"zone2\".",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectGroupIntent": {
"description": "The user's intent for this group. This is the only required field besides\nthe name that must be specified on group creation.",
"id": "InterconnectGroupIntent",
"properties": {
"topologyCapability": {
"enum": [
"NO_SLA",
"PRODUCTION_CRITICAL",
"PRODUCTION_NON_CRITICAL",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupInterconnect": {
"description": "An Interconnect in this InterconnectGroup.",
"id": "InterconnectGroupInterconnect",
"properties": {
"interconnect": {
"description": "The URL of an Interconnect in this group. All Interconnects in the group\nare unique.",
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupPhysicalStructure": {
"description": "[Output Only] An analysis of the physical layout of Interconnects in this\ngroup. Every Interconnect in the group is shown once in this structure.",
"id": "InterconnectGroupPhysicalStructure",
"properties": {
"metros": {
"items": {
"$ref": "InterconnectGroupPhysicalStructureMetros"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectGroupPhysicalStructureMetros": {
"description": "[Output Only] The metros Interconnects in this group are in.",
"id": "InterconnectGroupPhysicalStructureMetros",
"properties": {
"facilities": {
"items": {
"$ref": "InterconnectGroupPhysicalStructureMetrosFacilities"
},
"readOnly": true,
"type": "array"
},
"metro": {
"description": "Output only. [Output Only] The name of the metro, as a three-letter lowercase string\nlike \"iad\". This is the first component of the location of\nInterconnects underneath this.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupPhysicalStructureMetrosFacilities": {
"description": "[Output Only] The facilities Interconnects in this metro are present\nin.",
"id": "InterconnectGroupPhysicalStructureMetrosFacilities",
"properties": {
"facility": {
"description": "Output only. [Output Only] The ID of this facility, as a numeric string like\n\"5467\". This is the third component of the location of Interconnects\nin this facility.",
"readOnly": true,
"type": "string"
},
"zones": {
"items": {
"$ref": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"InterconnectGroupPhysicalStructureMetrosFacilitiesZones": {
"description": "[Output Only] The zones that Interconnects in this facility are\npresent in.",
"id": "InterconnectGroupPhysicalStructureMetrosFacilitiesZones",
"properties": {
"interconnects": {
"description": "Output only. [Output Only] URLs of Interconnects in this redundancy group in the\ngiven metro, facility, and zone.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"zone": {
"description": "Output only. [Output Only] The name of the zone, either \"zone1\" or \"zone2\".\nThis is the second component of the location of Interconnects in\nthis facility.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectGroupsCreateMembers": {
"id": "InterconnectGroupsCreateMembers",
"properties": {
"intentMismatchBehavior": {
"description": "How to behave when configured.topologyCapability.supportedSLA would not\nequal intent.topologyCapability after this call.",
"enum": [
"CREATE",
"REJECT",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"interconnects": {
"items": {
"$ref": "InterconnectGroupsCreateMembersInterconnectInput"
},
"type": "array"
},
"templateInterconnect": {
"$ref": "InterconnectGroupsCreateMembersInterconnectInput",
"description": "Parameters for the Interconnects to create."
}
},
"type": "object"
},
"InterconnectGroupsCreateMembersInterconnectInput": {
"id": "InterconnectGroupsCreateMembersInterconnectInput",
"properties": {
"adminEnabled": {
"description": "Administrative status of the interconnect. When this is set to true, the\nInterconnect is functional and can carry traffic.\nWhen set to false, no packets can be carried over the interconnect and\nno BGP routes are exchanged over it. By default, the status is set to\ntrue.",
"type": "boolean"
},
"customerName": {
"description": "Customer name, to put in the Letter of Authorization as the party\nauthorized to request a crossconnect.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"facility": {
"description": "A zone-free location to use for all Interconnects created in this call,\nlike \"iad-1234\".",
"type": "string"
},
"interconnectType": {
"description": "Type of interconnect, which can take one of the following values:\n   \n   - PARTNER: A partner-managed interconnection shared between\n   customers though a partner. \n   - DEDICATED: A dedicated physical\n   interconnection with the customer.\n\n Note that a value IT_PRIVATE\nhas been deprecated in favor of DEDICATED.",
"enum": [
"DEDICATED",
"IT_PRIVATE",
"PARTNER"
],
"enumDescriptions": [
"A dedicated physical interconnection with the customer.",
"[Deprecated] A private, physical interconnection with the customer.",
"A partner-managed interconnection shared between customers via partner."
],
"type": "string"
},
"linkType": {
"description": "Type of link requested, which can take one of the following values:\n   \n   - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics\n   - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics.\n   - LINK_TYPE_ETHERNET_400G_LR4: A 400G Ethernet with LR4\n   optics.\n\n Note that this field indicates the speed of each of the\nlinks in the bundle, not the speed of the entire bundle.",
"enum": [
"LINK_TYPE_ETHERNET_100G_LR",
"LINK_TYPE_ETHERNET_10G_LR",
"LINK_TYPE_ETHERNET_400G_LR4"
],
"enumDescriptions": [
"100G Ethernet, LR Optics.",
"10G Ethernet, LR Optics.\n[(rate_bps) =  10000000000];",
"400G Ethernet, LR4 Optics."
],
"type": "string"
},
"name": {
"description": "Name of the Interconnects to be created. This must be specified on the\ntemplate and/or on each individual interconnect. The name, if not empty,\nmust be 1-63 characters long, and comply with RFC1035.\nSpecifically, any nonempty name must be 1-63 characters long and match\nthe regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"type": "string"
},
"nocContactEmail": {
"description": "Email address to contact the customer NOC for operations and maintenance\nnotifications regarding this Interconnect. If specified, this will be\nused for notifications in addition to all other forms described, such as\nCloud Monitoring logs alerting and Cloud Notifications. This field is\nrequired for users who sign up for Cloud Interconnect using\nworkforce identity federation.",
"type": "string"
},
"remoteLocation": {
"description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies\nthe location outside of Google's network that the interconnect is\nconnected to.",
"type": "string"
},
"requestedFeatures": {
"description": "Optional. List of features requested for this Interconnect connection,\nwhich can take one of the following values:\n   \n   - IF_MACSEC: If specified, then the connection is created on MACsec\n   capable hardware ports. If not specified, non-MACsec capable ports will\n   also be considered.\n   - IF_CROSS_SITE_NETWORK: If specified, then the connection is created\n   exclusively for Cross-Site Networking. The connection can not be used for\n   Cross-Site Networking unless this feature is specified.",
"items": {
"enum": [
"IF_CROSS_SITE_NETWORK",
"IF_L2_FORWARDING",
"IF_MACSEC"
],
"enumDescriptions": [
"Cross-Site Networking",
"L2 Interconnect Attachment Forwarding",
"Media Access Control security (MACsec)"
],
"type": "string"
},
"type": "array"
},
"requestedLinkCount": {
"description": "Target number of physical links in the link bundle, as requested by the\ncustomer.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectGroupsCreateMembersRequest": {
"id": "InterconnectGroupsCreateMembersRequest",
"properties": {
"request": {
"$ref": "InterconnectGroupsCreateMembers"
}
},
"type": "object"
},
"InterconnectGroupsGetOperationalStatusResponse": {
"description": "Response for the InterconnectGroupsGetOperationalStatusResponse.",
"id": "InterconnectGroupsGetOperationalStatusResponse",
"properties": {
"etag": {
"type": "string"
},
"result": {
"$ref": "InterconnectGroupsOperationalStatus"
}
},
"type": "object"
},
"InterconnectGroupsListResponse": {
"id": "InterconnectGroupsListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InterconnectGroup resources.",
"items": {
"$ref": "InterconnectGroup"
},
"type": "array"
},
"kind": {
"default": "compute#InterconnectGroup",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InterconnectGroupsOperationalStatus": {
"description": "Request to get the status of the interconnect group with extra detail.",
"id": "InterconnectGroupsOperationalStatus",
"properties": {
"configured": {
"$ref": "InterconnectGroupConfigured",
"description": "Output only. The configuration analysis, as returned by Get.",
"readOnly": true
},
"groupStatus": {
"description": "Output only. Summarizes the status of the group.",
"enum": [
"DEGRADED",
"FULLY_DOWN",
"FULLY_UP",
"GROUPS_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"intent": {
"$ref": "InterconnectGroupIntent",
"description": "Output only. The intent of the resource, as returned by Get.",
"readOnly": true
},
"interconnectStatuses": {
"items": {
"$ref": "InterconnectGroupsOperationalStatusInterconnectStatus"
},
"readOnly": true,
"type": "array"
},
"operational": {
"$ref": "InterconnectGroupConfigured",
"description": "Output only. The operational state of the group, including only active Interconnects.",
"readOnly": true
}
},
"type": "object"
},
"InterconnectGroupsOperationalStatusInterconnectStatus": {
"description": "The status of one Interconnect in the group. The order is arbitrary.",
"id": "InterconnectGroupsOperationalStatusInterconnectStatus",
"properties": {
"adminEnabled": {
"description": "Output only. Whether the Interconnect is enabled.",
"readOnly": true,
"type": "boolean"
},
"diagnostics": {
"$ref": "InterconnectDiagnostics",
"description": "Output only. The diagnostics of the Interconnect, as returned by the existing\nget-diagnostics method.",
"readOnly": true
},
"interconnect": {
"description": "Output only. The URL of the Interconnect being described.",
"readOnly": true,
"type": "string"
},
"isActive": {
"description": "Output only. Whether this interconnect is participating in the redundant\nconfiguration.",
"enum": [
"ACTIVE",
"INACTIVE",
"IS_ACTIVE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"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. [Output Only] Type of resource. Alwayscompute#interconnectList for lists of interconnects.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nattachment (VLAN). For more information about interconnect attachments, read\nCreating VLAN Attachments.",
"id": "InterconnectLocation",
"properties": {
"address": {
"description": "Output only. [Output Only] The postal address of the Point of Presence, each line in\nthe address is separated by a newline character.",
"readOnly": true,
"type": "string"
},
"availabilityZone": {
"description": "[Output Only] Availability zone for this InterconnectLocation. Within a\nmetropolitan area (metro), maintenance will not be simultaneously scheduled\nin more than one availability zone.  Example: \"zone1\" or \"zone2\".",
"type": "string"
},
"availableFeatures": {
"description": "[Output only] List of features available at this InterconnectLocation,\nwhich can take one of the following values:\n   \n   - IF_MACSEC\n   - IF_CROSS_SITE_NETWORK",
"items": {
"enum": [
"IF_CROSS_SITE_NETWORK",
"IF_L2_FORWARDING",
"IF_MACSEC"
],
"enumDescriptions": [
"Cross-Site Networking",
"L2 Interconnect Attachment Forwarding",
"Media Access Control security (MACsec)"
],
"type": "string"
},
"type": "array"
},
"availableLinkTypes": {
"description": "[Output only] List of link types available at this InterconnectLocation,\nwhich can take one of the following values:\n   \n   - LINK_TYPE_ETHERNET_10G_LR\n   - LINK_TYPE_ETHERNET_100G_LR\n   - LINK_TYPE_ETHERNET_400G_LR4",
"items": {
"enum": [
"LINK_TYPE_ETHERNET_100G_LR",
"LINK_TYPE_ETHERNET_10G_LR",
"LINK_TYPE_ETHERNET_400G_LR4"
],
"enumDescriptions": [
"100G Ethernet, LR Optics.",
"10G Ethernet, LR Optics.\n[(rate_bps) =  10000000000];",
"400G Ethernet, LR4 Optics."
],
"type": "string"
},
"type": "array"
},
"city": {
"description": "[Output Only] Metropolitan area designator that indicates which city an\ninterconnect is located.\nFor example: \"Chicago, IL\", \"Amsterdam, Netherlands\".",
"type": "string"
},
"continent": {
"description": "[Output Only] Continent for this location, which can take one of the\nfollowing values:\n   \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. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"crossSiteInterconnectInfos": {
"description": "[Output Only] A list of InterconnectLocation.CrossSiteInterconnectInfo\nobjects, that describe where Cross-Site Interconnect wires may connect to\nfrom this location and associated connection parameters. Cross-Site\nInterconnect isn't allowed to locations which are not listed.",
"items": {
"$ref": "InterconnectLocationCrossSiteInterconnectInfo"
},
"type": "array"
},
"description": {
"description": "Output only. [Output Only] An optional description of the resource.",
"readOnly": true,
"type": "string"
},
"facilityProvider": {
"description": "Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).",
"readOnly": true,
"type": "string"
},
"facilityProviderFacilityId": {
"description": "Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,\nAshburn-DC1).",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#interconnectLocation",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#interconnectLocation for interconnect locations.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] Name of the resource.",
"readOnly": true,
"type": "string"
},
"peeringdbFacilityId": {
"description": "Output only. [Output Only] The peeringdb identifier for this facility (corresponding\nwith a netfac type in peeringdb).",
"readOnly": true,
"type": "string"
},
"regionInfos": {
"description": "Output only. [Output Only] A list of InterconnectLocation.RegionInfo objects, that\ndescribe parameters pertaining to the relation between this\nInterconnectLocation and various Google Cloud regions.",
"items": {
"$ref": "InterconnectLocationRegionInfo"
},
"readOnly": true,
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"singleRegionProductionCriticalPeerLocations": {
"description": "Output only. [Output Only] URLs of the other locations that can pair up with this\nlocation to support Single-Region 99.99% SLA. E.g. iad-zone1-1 and\niad-zone2-5467 are Single-Region 99.99% peer locations of each other.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"status": {
"description": "[Output Only] The status of this InterconnectLocation, which can take one\nof the following values:\n   \n   - CLOSED: The InterconnectLocation is closed and is unavailable for\n   provisioning new Interconnects.\n   - AVAILABLE: The InterconnectLocation is available for provisioning new\n   Interconnects.",
"enum": [
"AVAILABLE",
"CLOSED"
],
"enumDescriptions": [
"The InterconnectLocation is available for provisioning new Interconnects.",
"The InterconnectLocation is closed for provisioning new Interconnects."
],
"type": "string"
},
"supportsPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
}
},
"type": "object"
},
"InterconnectLocationCrossSiteInterconnectInfo": {
"description": "Information about Cross-Site Interconnect wires which may be created\nbetween the containing location and another remote location.",
"id": "InterconnectLocationCrossSiteInterconnectInfo",
"properties": {
"city": {
"description": "Output only. The remote location for Cross-Site Interconnect wires. This specifies an\nInterconnectLocation city (metropolitan area designator), which itself\nmay match multiple InterconnectLocations.",
"readOnly": true,
"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. [Output Only] Type of resource. Alwayscompute#interconnectLocationList for lists of interconnect\nlocations.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nInterconnect at a specific InterconnectLocation, and a specific Cloud\nRegion.",
"id": "InterconnectLocationRegionInfo",
"properties": {
"expectedRttMs": {
"description": "Output only. Expected round-trip time in milliseconds, from this InterconnectLocation\nto a VM in this region.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"l2ForwardingEnabled": {
"description": "Output only. Identifies whether L2 Interconnect Attachments can be created in this\nregion for interconnects that are in this location.",
"readOnly": true,
"type": "boolean"
},
"locationPresence": {
"description": "Output only. Identifies the network presence of this location.",
"enum": [
"GLOBAL",
"LOCAL_REGION",
"LP_GLOBAL",
"LP_LOCAL_REGION"
],
"enumDescriptions": [
"This region is not in any common network presence with this\nInterconnectLocation.",
"This region shares the same regional network presence as this\nInterconnectLocation.",
"[Deprecated] This region is not in any common network presence with\nthis InterconnectLocation.",
"[Deprecated] This region shares the same regional network presence as\nthis InterconnectLocation."
],
"readOnly": true,
"type": "string"
},
"region": {
"description": "Output only. URL for the region of this location.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectMacsec": {
"description": "Configuration information for enabling Media Access Control security\n(MACsec) on this Cloud Interconnect connection between Google and your\non-premises router.",
"id": "InterconnectMacsec",
"properties": {
"failOpen": {
"description": "If set to true, the Interconnect connection is configured with ashould-secure MACsec security policy, that allows the Google\nrouter to fallback to cleartext traffic if the MKA session cannot be\nestablished. By default, the Interconnect connection is configured with amust-secure security policy that drops all traffic if the\nMKA session cannot be established with your router.",
"type": "boolean"
},
"preSharedKeys": {
"description": "Required. A keychain placeholder describing a set of named key objects\nalong with their start times. A MACsec CKN/CAK is generated for each\nkey in the key chain. Google router automatically picks the key with\nthe most recent startTime when establishing or re-establishing a MACsec\nsecure link.",
"items": {
"$ref": "InterconnectMacsecPreSharedKey"
},
"type": "array"
}
},
"type": "object"
},
"InterconnectMacsecConfig": {
"description": "MACsec configuration information for the Interconnect connection. Contains\nthe generated Connectivity Association Key Name (CKN) and the key (CAK) for\nthis Interconnect connection.",
"id": "InterconnectMacsecConfig",
"properties": {
"preSharedKeys": {
"description": "A keychain placeholder describing a set of named key objects\nalong with their start times. A MACsec CKN/CAK is generated for each key in\nthe key chain. Google router automatically picks the key with the most\nrecent startTime when establishing or re-establishing a MACsec secure link.",
"items": {
"$ref": "InterconnectMacsecConfigPreSharedKey"
},
"type": "array"
}
},
"type": "object"
},
"InterconnectMacsecConfigPreSharedKey": {
"description": "Describes a pre-shared key used to setup MACsec in static connectivity\nassociation key (CAK) mode.",
"id": "InterconnectMacsecConfigPreSharedKey",
"properties": {
"cak": {
"description": "An auto-generated Connectivity Association Key (CAK) for this key.",
"type": "string"
},
"ckn": {
"description": "An auto-generated Connectivity Association Key Name (CKN) for this key.",
"type": "string"
},
"name": {
"description": "User provided name for this pre-shared key.",
"type": "string"
},
"startTime": {
"description": "User provided timestamp on or after which this key is valid.",
"type": "string"
}
},
"type": "object"
},
"InterconnectMacsecPreSharedKey": {
"description": "Describes a pre-shared key used to setup MACsec in static connectivity\nassociation key (CAK) mode.",
"id": "InterconnectMacsecPreSharedKey",
"properties": {
"name": {
"description": "Required. A name for this pre-shared key.\nThe name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be\na dash.",
"type": "string"
},
"startTime": {
"description": "A RFC3339 timestamp on or after which the key is\nvalid. startTime can be in the future. If the keychain has a single\nkey, startTime can be omitted. If the keychain has multiple keys,\nstartTime is mandatory for each key. The start times of keys must be in\nincreasing order. The start times of two consecutive keys must be\nat least 6 hours apart.",
"type": "string"
}
},
"type": "object"
},
"InterconnectOutageNotification": {
"description": "Description of a planned outage on this Interconnect.",
"id": "InterconnectOutageNotification",
"properties": {
"affectedCircuits": {
"description": "If issue_type is IT_PARTIAL_OUTAGE, a list of the Google-side circuit\nIDs 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\nepoch).",
"format": "int64",
"type": "string"
},
"issueType": {
"description": "Form this outage is expected to take, which can take one of the following\nvalues:\n   \n   - OUTAGE: The Interconnect may be completely out of service for\n   some or all of the specified window.\n   - PARTIAL_OUTAGE: Some circuits comprising the Interconnect as a whole\n   should remain up, but with reduced bandwidth.\n\n\nNote that the versions of this enum prefixed with \"IT_\" have been\ndeprecated in favor of the unprefixed values.",
"enum": [
"IT_OUTAGE",
"IT_PARTIAL_OUTAGE",
"OUTAGE",
"PARTIAL_OUTAGE"
],
"enumDescriptions": [
"[Deprecated] The Interconnect may be completely out of service for some\nor all of the specified window.",
"[Deprecated] Some circuits comprising the Interconnect will be out of\nservice during the expected window. The interconnect as a whole should\nremain up, albeit with reduced bandwidth.",
"The Interconnect may be completely out of service for some or all of\nthe specified window.",
"Some circuits comprising the Interconnect will be out of service during\nthe expected window. The interconnect as a whole should remain\nup, albeit with reduced bandwidth."
],
"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\nvalue:\n   \n   - GOOGLE: this notification as generated by Google.\n\n\nNote that the value of NSRC_GOOGLE has been deprecated in favor of\nGOOGLE.",
"enum": [
"GOOGLE",
"NSRC_GOOGLE"
],
"enumDescriptions": [
"This notification was generated by Google.",
"[Deprecated] This notification was generated by Google."
],
"type": "string"
},
"startTime": {
"description": "Scheduled start time for the outage (milliseconds since Unix\nepoch).",
"format": "int64",
"type": "string"
},
"state": {
"description": "State of this notification, which can take one of the following values:\n   \n   - ACTIVE: This outage notification is active. The event could be in\n   the past, present, or future. See start_time and end_time for\n   scheduling.\n   - CANCELLED: The outage associated with this notification was cancelled\n   before the outage was due to start.\n   - COMPLETED: The outage associated with this notification is complete.\n\n\nNote that the versions of this enum prefixed with \"NS_\" have been\ndeprecated in favor of the unprefixed values.",
"enum": [
"ACTIVE",
"CANCELLED",
"COMPLETED",
"NS_ACTIVE",
"NS_CANCELED"
],
"enumDescriptions": [
"This outage notification is active. The event could be in the future,\npresent, or past. See start_time and end_time for scheduling.",
"The outage associated with this notification was cancelled before the\noutage was due to start.",
"The outage associated with this notification is complete.",
"[Deprecated] This outage notification is active. The event could be in\nthe future, present, or past. See start_time and end_time for\nscheduling.",
"[Deprecated] The outage associated with this notification was canceled\nbefore the outage was due to start."
],
"type": "string"
}
},
"type": "object"
},
"InterconnectParams": {
"description": "Additional interconnect parameters.",
"id": "InterconnectParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"InterconnectRemoteLocation": {
"description": "Represents a Cross-Cloud Interconnect Remote Location resource.\n\nYou can use this resource to find remote location details about an\nInterconnect attachment (VLAN).",
"id": "InterconnectRemoteLocation",
"properties": {
"address": {
"description": "Output only. [Output Only] The postal address of the Point of Presence, each line in\nthe address is separated by a newline character.",
"readOnly": true,
"type": "string"
},
"attachmentConfigurationConstraints": {
"$ref": "InterconnectAttachmentConfigurationConstraints",
"description": "Output only. [Output Only] Subset of fields from InterconnectAttachment's\n|configurationConstraints| field that apply to all attachments for this\nremote location.",
"readOnly": true
},
"city": {
"description": "Output only. [Output Only] Metropolitan area designator that indicates which city an\ninterconnect is located.\nFor example: \"Chicago, IL\", \"Amsterdam, Netherlands\".",
"readOnly": true,
"type": "string"
},
"constraints": {
"$ref": "InterconnectRemoteLocationConstraints",
"description": "Output only. [Output Only] Constraints on the parameters for creating Cross-Cloud\nInterconnect and associated InterconnectAttachments.",
"readOnly": true
},
"continent": {
"description": "Output only. [Output Only] Continent for this location, which can take one of the\nfollowing values:\n   \n   - AFRICA\n   - ASIA_PAC\n   - EUROPE\n   - NORTH_AMERICA\n   - SOUTH_AMERICA",
"enum": [
"AFRICA",
"ASIA_PAC",
"EUROPE",
"NORTH_AMERICA",
"SOUTH_AMERICA"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. [Output Only] An optional description of the resource.",
"readOnly": true,
"type": "string"
},
"facilityProvider": {
"description": "Output only. [Output Only] The name of the provider for this facility (e.g., EQUINIX).",
"readOnly": true,
"type": "string"
},
"facilityProviderFacilityId": {
"description": "Output only. [Output Only] A provider-assigned Identifier for this facility (e.g.,\nAshburn-DC1).",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#interconnectRemoteLocation",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#interconnectRemoteLocation for interconnect remote\nlocations.",
"readOnly": true,
"type": "string"
},
"lacp": {
"description": "Output only. [Output Only] Link Aggregation Control Protocol (LACP) constraints, which\ncan take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED",
"enum": [
"LACP_SUPPORTED",
"LACP_UNSUPPORTED"
],
"enumDescriptions": [
"LACP_SUPPORTED: LACP is supported, and enabled by default on\nthe Cross-Cloud Interconnect.",
"LACP_UNSUPPORTED: LACP is not supported and is not be enabled on this\nport. GetDiagnostics shows bundleAggregationType as \"static\". GCP does\nnot support LAGs without LACP, so requestedLinkCount must be 1."
],
"readOnly": true,
"type": "string"
},
"maxLagSize100Gbps": {
"description": "Output only. [Output Only]\nThe maximum number of 100 Gbps ports supported in a link aggregation group\n(LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed\nmax_lag_size_100_gbps.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"maxLagSize10Gbps": {
"description": "Output only. [Output Only]\nThe maximum number of 10 Gbps ports supported in a link aggregation group\n(LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed\nmax_lag_size_10_gbps.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"maxLagSize400Gbps": {
"description": "Output only. [Output Only]\nThe maximum number of 400 Gbps ports supported in a link aggregation group\n(LAG). When linkType is 400 Gbps, requestedLinkCount cannot exceed\nmax_lag_size_400_gbps.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Output only. [Output Only] Name of the resource.",
"readOnly": true,
"type": "string"
},
"peeringdbFacilityId": {
"description": "Output only. [Output Only] The peeringdb identifier for this facility (corresponding\nwith a netfac type in peeringdb).",
"readOnly": true,
"type": "string"
},
"permittedConnections": {
"description": "Output only. [Output Only] Permitted connections.",
"items": {
"$ref": "InterconnectRemoteLocationPermittedConnections"
},
"readOnly": true,
"type": "array"
},
"remoteService": {
"description": "Output only. [Output Only] Indicates the service provider present at the remote\nlocation. Example values: \"Amazon Web Services\", \"Microsoft Azure\".",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of this InterconnectRemoteLocation, which can take\none of the following values:\n   \n   - CLOSED: The InterconnectRemoteLocation is closed and is unavailable\n   for provisioning new Cross-Cloud Interconnects. \n   - AVAILABLE: The\n   InterconnectRemoteLocation is available for provisioning new\n   Cross-Cloud Interconnects.",
"enum": [
"AVAILABLE",
"CLOSED"
],
"enumDescriptions": [
"The InterconnectRemoteLocation is available for provisioning new\nCross-Cloud Interconnects.",
"The InterconnectRemoteLocation is closed for provisioning new\nCross-Cloud Interconnects."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectRemoteLocationConstraints": {
"id": "InterconnectRemoteLocationConstraints",
"properties": {
"portPairRemoteLocation": {
"description": "Output only. [Output Only] Port pair remote location constraints, which can take one\nof the following values: PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION,\nPORT_PAIR_MATCHING_REMOTE_LOCATION.\n\nGoogle Cloud API refers only to individual ports, but the UI uses this\nfield when ordering a pair of ports, to prevent users from accidentally\nordering something that is incompatible with their cloud provider.\nSpecifically, when ordering a redundant pair of Cross-Cloud Interconnect\nports, and one of them uses a remote location with\nportPairMatchingRemoteLocation set to matching, the UI requires that\nboth ports use the same remote location.",
"enum": [
"PORT_PAIR_MATCHING_REMOTE_LOCATION",
"PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION"
],
"enumDescriptions": [
"If PORT_PAIR_MATCHING_REMOTE_LOCATION, the remote cloud provider\nallocates ports in pairs, and the user should choose the same remote\nlocation for both ports.",
"If PORT_PAIR_UNCONSTRAINED_REMOTE_LOCATION, a user may opt to provision\na redundant pair of Cross-Cloud Interconnects using two different\nremote locations in the same city."
],
"readOnly": true,
"type": "string"
},
"portPairVlan": {
"description": "Output only. [Output Only] Port pair VLAN constraints, which can take one of the\nfollowing values: PORT_PAIR_UNCONSTRAINED_VLAN, PORT_PAIR_MATCHING_VLAN",
"enum": [
"PORT_PAIR_MATCHING_VLAN",
"PORT_PAIR_UNCONSTRAINED_VLAN"
],
"enumDescriptions": [
"If PORT_PAIR_MATCHING_VLAN, the Interconnect for this attachment is\npart of a pair of ports that should have matching VLAN allocations.\nThis occurs with Cross-Cloud Interconnect to Azure remote locations.\nWhile GCP's API does not explicitly group pairs of ports, the UI uses\nthis field to ensure matching VLAN ids when configuring a redundant\nVLAN pair.",
"PORT_PAIR_UNCONSTRAINED_VLAN means there is no constraint."
],
"readOnly": true,
"type": "string"
},
"subnetLengthRange": {
"$ref": "InterconnectRemoteLocationConstraintsSubnetLengthRange",
"description": "Output only. [Output Only]\n\n[min-length, max-length] \n\nThe minimum and maximum value (inclusive) for the IPv4 subnet\nlength.\n\n For example, an  interconnectRemoteLocation for Azure has {min: 30,\nmax:\n30} because Azure requires /30 subnets. \n\nThis range specifies the values supported by both cloud providers.\nInterconnect currently supports /29 and /30 IPv4 subnet lengths. If a\nremote cloud has no constraint on IPv4 subnet length, the range would\nthus be {min: 29, max: 30}.",
"readOnly": true
}
},
"type": "object"
},
"InterconnectRemoteLocationConstraintsSubnetLengthRange": {
"id": "InterconnectRemoteLocationConstraintsSubnetLengthRange",
"properties": {
"max": {
"format": "int32",
"type": "integer"
},
"min": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"InterconnectRemoteLocationList": {
"description": "Response to the list request, and contains a list of interconnect remote\nlocations.",
"id": "InterconnectRemoteLocationList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InterconnectRemoteLocation resources.",
"items": {
"$ref": "InterconnectRemoteLocation"
},
"type": "array"
},
"kind": {
"default": "compute#interconnectRemoteLocationList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#interconnectRemoteLocationList for lists of\ninterconnect remote locations.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token lets you get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"InterconnectRemoteLocationPermittedConnections": {
"id": "InterconnectRemoteLocationPermittedConnections",
"properties": {
"interconnectLocation": {
"description": "Output only. [Output Only] URL of an Interconnect location that is permitted to\nconnect to this Interconnect remote location.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"InterconnectsGetDiagnosticsResponse": {
"description": "Response for the InterconnectsGetDiagnosticsRequest.",
"id": "InterconnectsGetDiagnosticsResponse",
"properties": {
"result": {
"$ref": "InterconnectDiagnostics"
}
},
"type": "object"
},
"InterconnectsGetMacsecConfigResponse": {
"description": "Response for the InterconnectsGetMacsecConfigRequest.",
"id": "InterconnectsGetMacsecConfigResponse",
"properties": {
"etag": {
"description": "end_interface: MixerGetResponseWithEtagBuilder",
"type": "string"
},
"result": {
"$ref": "InterconnectMacsecConfig"
}
},
"type": "object"
},
"License": {
"description": "Represents a License resource.\n\nA License represents billing and aggregate usage data forpublic andmarketplace images.\n *Caution* This resource is intended for\nuse only by third-party partners who are creatingCloud Marketplace\nimages.",
"id": "License",
"properties": {
"allowedReplacementLicenses": {
"description": "Specifies licenseCodes of licenses that can replace this license. Note:\nsuch replacements are allowed even if removable_from_disk is false.",
"items": {
"type": "string"
},
"type": "array"
},
"appendableToDisk": {
"description": "If true, this license can be appended to an existing disk's set of\nlicenses.",
"type": "boolean"
},
"chargesUseFee": {
"description": "[Output Only] Deprecated. This field no longer reflects whether a license\ncharges a usage fee.",
"type": "boolean"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional textual description of the resource; provided by the client\nwhen the resource is created.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"incompatibleLicenses": {
"description": "Specifies licenseCodes of licenses that are incompatible with this license.\nIf a license is incompatible with this license, it cannot be attached to\nthe same disk or image.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"default": "compute#license",
"description": "Output only. [Output Only] Type of resource. Always compute#license for\nlicenses.",
"readOnly": true,
"type": "string"
},
"licenseCode": {
"description": "[Output Only] The unique code used to attach this license to images,\nsnapshots, and disks.",
"format": "uint64",
"type": "string"
},
"minimumRetention": {
"$ref": "Duration",
"description": "If set, this license will be unable to be removed or replaced once attached\nto a disk until the minimum_retention period has passed."
},
"multiTenantOnly": {
"description": "If true, this license can only be used on VMs on multi tenant nodes.",
"type": "boolean"
},
"name": {
"annotations": {
"required": [
"compute.images.insert"
]
},
"description": "Name of the resource. The name must be 1-63 characters long and\ncomply withRFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"osLicense": {
"description": "If true, indicates this is an OS license. Only one OS license can be\nattached to a disk or image at a time.",
"type": "boolean"
},
"params": {
"$ref": "LicenseParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"removableFromDisk": {
"description": "If true, this license can be removed from a disk's set of licenses, with no\nreplacement license needed.",
"type": "boolean"
},
"requiredCoattachedLicenses": {
"description": "Specifies the set of permissible coattached licenseCodes of licenses that\nsatisfy the coattachment requirement of this license. At least one license\nfrom the set must be attached to the same disk or image as this license.",
"items": {
"type": "string"
},
"type": "array"
},
"resourceRequirements": {
"$ref": "LicenseResourceRequirements",
"description": "[Input Only] Deprecated."
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"soleTenantOnly": {
"description": "If true, this license can only be used on VMs on sole tenant nodes.",
"type": "boolean"
},
"transferable": {
"description": "If false, licenses will not be copied from the source resource when\ncreating an image from a disk, disk from snapshot, or snapshot from disk.",
"type": "boolean"
},
"updateTimestamp": {
"description": "Output only. [Output Only] Last update timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LicenseCode": {
"description": "Represents a License Code resource.\n\nA License Code is a unique identifier used to represent alicense\nresource.\n *Caution* This resource is intended for\nuse only by third-party partners who are creatingCloud Marketplace\nimages.",
"id": "LicenseCode",
"properties": {
"allowedReplacementLicenses": {
"description": "Specifies licenseCodes of licenses that can replace this license. Note:\nsuch replacements are allowed even if removable_from_disk is false.",
"items": {
"type": "string"
},
"type": "array"
},
"appendableToDisk": {
"description": "If true, this license can be appended to an existing disk's set of\nlicenses.",
"type": "boolean"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. [Output Only] Description of this License Code.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"incompatibleLicenses": {
"description": "Specifies licenseCodes of licenses that are incompatible with this license.\nIf a license is incompatible with this license, it cannot be attached to\nthe same disk or image.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"default": "compute#licenseCode",
"description": "Output only. [Output Only] Type of resource. Always compute#licenseCode for\nlicenses.",
"readOnly": true,
"type": "string"
},
"licenseAlias": {
"description": "[Output Only] URL and description aliases of Licenses with the same\nLicense Code.",
"items": {
"$ref": "LicenseCodeLicenseAlias"
},
"type": "array"
},
"minimumRetention": {
"$ref": "Duration",
"description": "If set, this license will be unable to be removed or replaced once attached\nto a disk until the minimum_retention period has passed."
},
"multiTenantOnly": {
"description": "If true, this license can only be used on VMs on multi tenant nodes.",
"type": "boolean"
},
"name": {
"annotations": {
"required": [
"compute.licenses.insert"
]
},
"description": "Output only. [Output Only] Name of the resource. The name is 1-20 characters long and\nmust be a valid 64 bit integer.",
"pattern": "[0-9]{0,20}?",
"readOnly": true,
"type": "string"
},
"osLicense": {
"description": "If true, indicates this is an OS license. Only one OS license can be\nattached to a disk or image at a time.",
"type": "boolean"
},
"removableFromDisk": {
"description": "If true, this license can be removed from a disk's set of licenses, with no\nreplacement license needed.",
"type": "boolean"
},
"requiredCoattachedLicenses": {
"description": "Specifies the set of permissible coattached licenseCodes of licenses that\nsatisfy the coattachment requirement of this license. At least one license\nfrom the set must be attached to the same disk or image as this license.",
"items": {
"type": "string"
},
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"soleTenantOnly": {
"description": "If true, this license can only be used on VMs on sole tenant nodes.",
"type": "boolean"
},
"state": {
"description": "Output only. [Output Only] Current state of this License Code.",
"enum": [
"DISABLED",
"ENABLED",
"RESTRICTED",
"STATE_UNSPECIFIED",
"TERMINATED"
],
"enumDescriptions": [
"Machines are not allowed to attach boot disks with this License Code.\nRequests to create new resources with this license will be rejected.",
"Use is allowed for anyone with USE_READ_ONLY access to this License Code.",
"Use of this license is limited to a project whitelist.",
"",
"Reserved state."
],
"readOnly": true,
"type": "string"
},
"transferable": {
"description": "Output only. [Output Only] If true, the license will remain attached when creating\nimages or snapshots from disks. Otherwise, the license is not transferred.",
"readOnly": true,
"type": "boolean"
},
"updateTimestamp": {
"description": "Output only. [Output Only] Last update timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LicenseCodeLicenseAlias": {
"id": "LicenseCodeLicenseAlias",
"properties": {
"description": {
"description": "Output only. [Output Only] Description of this License Code.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] URL of license corresponding to this License Code.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"LicenseParams": {
"description": "Additional license params.",
"id": "LicenseParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the license. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"LicenseResourceCommitment": {
"description": "Commitment for a particular license resource.",
"id": "LicenseResourceCommitment",
"properties": {
"amount": {
"description": "The number of licenses you plan to purchase.",
"format": "int64",
"type": "string"
},
"coresPerLicense": {
"description": "The number of cores per license.",
"type": "string"
},
"license": {
"description": "The applicable license URI.",
"type": "string"
}
},
"type": "object"
},
"LicenseResourceRequirements": {
"id": "LicenseResourceRequirements",
"properties": {
"minGuestCpuCount": {
"description": "[Input Only] Deprecated. This field no longer reflects the minimum number\nof guest cpus required to use the Instance.",
"format": "int32",
"type": "integer"
},
"minMemoryMb": {
"description": "[Input Only] Deprecated. This field no longer reflects the minimum memory\nrequired to use the Instance.",
"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\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ListInstantSnapshotGroups": {
"description": "Contains a list of InstantSnapshotGroup resources.",
"id": "ListInstantSnapshotGroups",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of InstantSnapshotGroup resources.",
"items": {
"$ref": "InstantSnapshotGroup"
},
"type": "array"
},
"kind": {
"default": "compute#instantSnapshotGroupsList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"LocalDisk": {
"id": "LocalDisk",
"properties": {
"diskCount": {
"description": "Specifies the number of such disks.",
"format": "int32",
"type": "integer"
},
"diskSizeGb": {
"description": "Specifies the size of the disk in base-2 GB.",
"format": "int32",
"type": "integer"
},
"diskType": {
"description": "Specifies the desired disk type on the node. This disk type must be a\nlocal storage type (e.g.: local-ssd).\nNote that for nodeTemplates, this should be the name of the disk type and\nnot its URL.",
"type": "string"
}
},
"type": "object"
},
"LocalizedMessage": {
"description": "Provides a localized error message that is safe to return to the user\nwhich can be attached to an RPC error.",
"id": "LocalizedMessage",
"properties": {
"locale": {
"description": "The locale used following the specification defined at\nhttps://www.rfc-editor.org/rfc/bcp/bcp47.txt.\nExamples are: \"en-US\", \"fr-CH\", \"es-MX\"",
"type": "string"
},
"message": {
"description": "The localized error message in the above locale.",
"type": "string"
}
},
"type": "object"
},
"LocationPolicy": {
"description": "Configuration for location policy among multiple possible locations\n(e.g. preferences for zone selection among zones in a single region).",
"id": "LocationPolicy",
"properties": {
"locations": {
"additionalProperties": {
"$ref": "LocationPolicyLocation"
},
"description": "Location configurations mapped by location name.\nCurrently only zone names are supported and must be represented as valid\ninternal URLs, such as zones/us-central1-a.\nThe bulkInsert operation doesn't create instances in an AI zone, even if\nan AI zone is available in the specified region. For example, if you set a\nDENY preference for us-central1-a, Compute Engine will consider\nus-central1-b and us-central1-c for instance creation, but not\nus-central1-ai1a. Also, you can't use the locations[] configuration to\nallow instance creation in an AI zone. To include an AI zone in bulkInsert\noperations, use the locationPolicy.zones[] field.",
"type": "object"
},
"targetShape": {
"description": "Strategy for distributing VMs across zones in a region.",
"enum": [
"ANY",
"ANY_SINGLE_ZONE",
"BALANCED"
],
"enumDescriptions": [
"GCE picks zones for creating VM instances to fulfill the requested\nnumber of VMs within present resource constraints and to maximize\nutilization of unused zonal reservations. Recommended for batch workloads\nthat do not require high availability.",
"GCE always selects a single zone for all the VMs, optimizing for resource\nquotas, available reservations and general capacity. Recommended for\nbatch workloads that cannot tollerate distribution over multiple zones.\nThis the default shape in Bulk Insert and Capacity Advisor APIs.",
"GCE prioritizes acquisition of resources, scheduling VMs in zones\nwhere resources are available while distributing VMs as evenly as\npossible across allowed zones to minimize the impact of zonal failure.\nRecommended for highly available serving workloads."
],
"type": "string"
},
"zones": {
"description": "The bulkInsert operation applies any preferences set in the locations\nfield to the specific zones listed in the zones field if the same zones\nare specified in both fields.",
"items": {
"$ref": "LocationPolicyZoneConfiguration"
},
"type": "array"
}
},
"type": "object"
},
"LocationPolicyLocation": {
"id": "LocationPolicyLocation",
"properties": {
"constraints": {
"$ref": "LocationPolicyLocationConstraints",
"description": "Constraints that the caller requires on the result distribution\nin this zone."
},
"preference": {
"description": "Preference for a given location. Set to either ALLOW orDENY.",
"enum": [
"ALLOW",
"DENY",
"PREFERENCE_UNSPECIFIED"
],
"enumDescriptions": [
"Location is allowed for use.",
"Location is prohibited.",
"Default value, unused."
],
"type": "string"
}
},
"type": "object"
},
"LocationPolicyLocationConstraints": {
"description": "Per-zone constraints on location policy for this zone.",
"id": "LocationPolicyLocationConstraints",
"properties": {
"maxCount": {
"description": "Maximum number of items that are allowed to be placed in this zone.\nThe value must be non-negative.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"LocationPolicyZoneConfiguration": {
"id": "LocationPolicyZoneConfiguration",
"properties": {
"zone": {
"description": "The URL of the zone.\nThe zone must exist in the region where the request is called.\nZones must be represented as valid partial URLs,\nsuch as zones/us-central1-a.",
"type": "string"
}
},
"type": "object"
},
"MachineImage": {
"description": "Represents a machine image resource.\n\nA machine image is a Compute Engine resource that stores all the\nconfiguration, metadata, permissions, and data from one or more disks\nrequired to create a Virtual machine (VM) instance. For more information, seeMachine images.",
"id": "MachineImage",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp for this machine image inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"guestFlush": {
"description": "[Input Only] Whether to attempt an application consistent machine image by\ninforming the OS to prepare for the snapshot process.",
"type": "boolean"
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this machine image. The server\ndefines this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceProperties": {
"$ref": "InstanceProperties",
"description": "[Output Only] Properties of source instance"
},
"kind": {
"default": "compute#machineImage",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this machine image, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the\nmachine image.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this machine image. These can be later modified by\nthe setLabels method.",
"type": "object"
},
"machineImageEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the machine image using acustomer-supplied\nencryption key.\n\nAfter you encrypt a machine image using a customer-supplied key, you must\nprovide the same key if you use the machine image later. For example, you\nmust provide the encryption key when you create an instance from the\nencrypted machine image in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata of the\nmachine image.\n\nIf you do not provide an encryption key when creating the machine image,\nthen the machine image will be encrypted using an automatically generated\nkey and you do not need to provide a key to use the machine image later."
},
"name": {
"annotations": {
"required": [
"compute.machineImages.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "MachineImageParams",
"description": "Input only. [Input Only] Additional parameters that are passed in the request, but are\nnot persisted in the resource."
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"savedDisks": {
"description": "Output only. An array of Machine Image specific properties for disks attached to the\nsource instance",
"items": {
"$ref": "SavedDisk"
},
"readOnly": true,
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] The URL for this machine image. The server defines this URL.",
"readOnly": true,
"type": "string"
},
"sourceDiskEncryptionKeys": {
"description": "[Input Only] Thecustomer-supplied\nencryption key of the disks attached to the source instance. Required\nif the source disk is protected by a customer-supplied encryption key.",
"items": {
"$ref": "SourceDiskEncryptionKey"
},
"type": "array"
},
"sourceInstance": {
"description": "The source instance used to create the machine image. You can provide this\nas a partial or full URL to the resource. For example, the following are\nvalid values: \n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance \n   - projects/project/zones/zone/instances/instance",
"type": "string"
},
"sourceInstanceProperties": {
"$ref": "SourceInstanceProperties",
"description": "Output only. [Output Only] DEPRECATED: Please use instance_properties\ninstead for source instance related properties. New properties will not be\nadded to this field.",
"readOnly": true
},
"status": {
"description": "Output only. [Output Only] The status of the machine image. One of the following values:INVALID, CREATING, READY,DELETING, and UPLOADING.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY",
"UPLOADING"
],
"enumDescriptions": [
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"storageLocations": {
"description": "The regional or multi-regional Cloud Storage bucket location where themachine image is\nstored.",
"items": {
"type": "string"
},
"type": "array"
},
"totalStorageBytes": {
"description": "Output only. [Output Only] Total size of the storage used by the machine image.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"MachineImageList": {
"description": "A list of machine images.",
"id": "MachineImageList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of MachineImage resources.",
"items": {
"$ref": "MachineImage"
},
"type": "array"
},
"kind": {
"default": "compute#machineImageList",
"description": "Output only. [Output Only] The resource type, which is alwayscompute#machineImagesListResponse for machine image lists.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"MachineImageParams": {
"description": "Machine Image parameters",
"id": "MachineImageParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the machine image. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"MachineType": {
"description": "Represents a Machine Type resource.\n\nYou can use specific machine types for your VM instances based on performance\nand pricing requirements. For more information, readMachine Types.",
"id": "MachineType",
"properties": {
"accelerators": {
"description": "[Output Only] A list of accelerator configurations assigned to this\nmachine 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-t4.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"architecture": {
"description": "[Output Only] The architecture of the machine type.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"type": "string"
},
"bundledLocalSsds": {
"$ref": "BundledLocalSsds",
"description": "[Output Only] The configuration of bundled local SSD for the machine type."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this machine type.\nOnly applicable if the machine type is unavailable."
},
"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\ninstance.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"imageSpaceGb": {
"description": "[Deprecated] This property is deprecated and will never be populated with\nany relevant values.",
"format": "int32",
"type": "integer"
},
"isSharedCpu": {
"description": "[Output Only] Whether this machine type has a shared CPU. SeeShared-core machine\ntypes for more information.",
"type": "boolean"
},
"kind": {
"default": "compute#machineType",
"description": "Output only. [Output Only] The type of the resource. Alwayscompute#machineType for machine types.",
"readOnly": true,
"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,\ndefined 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 machine type resides,\nsuch 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. [Output Only] Type of resource. Alwayscompute#machineTypeAggregatedList for aggregated lists of\nmachine types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#machineTypeList\nfor lists of machine types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nlist is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] The current action that the managed instance group has\nscheduled for the instance. Possible values:\n   \n   - NONE The instance is running, and the managed\n   instance group does not have any scheduled actions for this instance.\n   - CREATING The managed instance group is creating this\n   instance. If the group fails to create this instance, it will try again\n   until it is successful.\n   - CREATING_WITHOUT_RETRIES The managed instance group\n   is attempting to create this instance only once. If the group fails\n   to create this instance, it does not try again and the group'stargetSize value is decreased instead.\n   - RECREATING The managed instance group is recreating\n   this instance.\n   - DELETING The managed instance group is permanently\n   deleting this instance.\n   - ABANDONING The managed instance group is abandoning\n   this instance. The instance will be removed from the instance group\n   and from any target pools that are associated with this group.\n   - RESTARTING The managed instance group is restarting\n   the instance.\n   - REFRESHING The managed instance group is applying\n   configuration changes to the instance without stopping it. For example,\n   the group can update the target pool list for an instance without\n   stopping that instance.\n   - VERIFYING The managed instance group has created the\n   instance and it is in the process of being verified.",
"enum": [
"ABANDONING",
"CREATING",
"CREATING_WITHOUT_RETRIES",
"DELETING",
"NONE",
"RECREATING",
"REFRESHING",
"RESTARTING",
"RESUMING",
"STARTING",
"STOPPING",
"SUSPENDING",
"VERIFYING"
],
"enumDescriptions": [
"The managed instance group is abandoning this instance. The instance\nwill be removed from the instance group and from any target pools that\nare associated with this group.",
"The managed instance group is creating this instance. If the group\nfails to create this instance, it will try again until it is\nsuccessful.",
"The managed instance group is attempting to create this instance\nonly once. If the group fails to create this instance, it does\nnot try again and the group's targetSize value is\ndecreased.",
"The managed instance group is permanently deleting this instance.",
"The managed instance group has not scheduled any actions for this\ninstance.",
"The managed instance group is recreating this instance.",
"The managed instance group is applying configuration changes to the\ninstance without stopping it. For example, the group can update the\ntarget pool list for an instance without stopping that instance.",
"The managed instance group is restarting this instance.",
"The managed instance group is resuming this instance.",
"The managed instance group is starting this instance.",
"The managed instance group is stopping this instance.",
"The managed instance group is suspending this instance.",
"The managed instance group is verifying this already created instance.\nVerification happens every time the instance is (re)created or restarted\nand consists of:\n 1. Waiting until health check specified as part of this managed instance\n    group's autohealing policy reports HEALTHY.\n    Note: Applies only if autohealing policy has a health check specified\n 2. Waiting for addition verification steps performed as post-instance\n    creation (subject to future extensions)."
],
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output only] The unique identifier for this resource. This field is empty\nwhen instance does not exist.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instance": {
"description": "Output only. [Output Only] The URL of the instance. The URL can exist even if the\ninstance has not yet been created.",
"readOnly": true,
"type": "string"
},
"instanceHealth": {
"description": "Output only. [Output Only] Health state of the instance per health-check.",
"items": {
"$ref": "ManagedInstanceInstanceHealth"
},
"readOnly": true,
"type": "array"
},
"instanceStatus": {
"description": "Output only. [Output Only] The status of the instance. This field is empty when\nthe instance does not exist.",
"enum": [
"DEPROVISIONING",
"PENDING",
"PROVISIONING",
"REPAIRING",
"RUNNING",
"STAGING",
"STOPPED",
"STOPPING",
"SUSPENDED",
"SUSPENDING",
"TERMINATED"
],
"enumDescriptions": [
"The instance is halted and we are performing tear down tasks like network\ndeprogramming, releasing quota, IP, tearing down disks etc.",
"For Flex Start provisioning instance is waiting for available capacity\nfrom Dynamic Workload Scheduler (DWS).",
"Resources are being allocated for the instance.",
"The instance is in repair.",
"The instance is running.",
"All required resources have been allocated and the instance\nis being started.",
"The instance has stopped successfully.",
"The instance is currently stopping (either being deleted or killed).",
"The instance has suspended.",
"The instance is suspending.",
"The instance has stopped (either by explicit action or underlying\nfailure)."
],
"readOnly": true,
"type": "string"
},
"lastAttempt": {
"$ref": "ManagedInstanceLastAttempt",
"description": "Output only. [Output Only] Information about the last attempt to create or delete\nthe instance.",
"readOnly": true
},
"name": {
"description": "Output only. [Output Only] The name of the instance. The name always exists even if the\ninstance has not yet been created.",
"readOnly": true,
"type": "string"
},
"preservedStateFromConfig": {
"$ref": "PreservedState",
"description": "Output only. [Output Only] Preserved state applied from per-instance config\nfor this instance.",
"readOnly": true
},
"preservedStateFromPolicy": {
"$ref": "PreservedState",
"description": "Output only. [Output Only] Preserved state generated based on stateful policy\nfor this instance.",
"readOnly": true
},
"propertiesFromFlexibilityPolicy": {
"$ref": "ManagedInstancePropertiesFromFlexibilityPolicy",
"description": "Output only. [Output Only] Instance properties selected for this instance resulting from\nInstanceFlexibilityPolicy.",
"readOnly": true
},
"version": {
"$ref": "ManagedInstanceVersion",
"description": "Output only. [Output Only] Intended version of this instance.",
"readOnly": true
}
},
"type": "object"
},
"ManagedInstanceInstanceHealth": {
"id": "ManagedInstanceInstanceHealth",
"properties": {
"detailedHealthState": {
"description": "Output only. [Output Only] The current detailed instance health state.",
"enum": [
"DRAINING",
"HEALTHY",
"TIMEOUT",
"UNHEALTHY",
"UNKNOWN"
],
"enumDescriptions": [
"The instance is being drained. The existing connections to the instance\nhave time to complete, but the new ones are being refused.",
"The instance is reachable i.e. a connection to the application health\nchecking endpoint can be established, and conforms to the requirements\ndefined by the health check.",
"The instance is unreachable i.e. a connection to the application health\nchecking endpoint cannot be established, or the server does not respond\nwithin the specified timeout.",
"The instance is reachable, but does not conform to the requirements\ndefined by the health check.",
"The health checking system is aware of the instance but its health is\nnot known at the moment."
],
"readOnly": true,
"type": "string"
},
"healthCheck": {
"description": "Output only. [Output Only] The URL for the health check that verifies whether the\ninstance is healthy.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ManagedInstanceLastAttempt": {
"id": "ManagedInstanceLastAttempt",
"properties": {
"errors": {
"description": "Output only. [Output Only] Encountered errors during the last attempt to create or\ndelete the instance.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"ManagedInstancePropertiesFromFlexibilityPolicy": {
"id": "ManagedInstancePropertiesFromFlexibilityPolicy",
"properties": {
"machineType": {
"description": "Output only. The machine type to be used for this instance.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ManagedInstanceVersion": {
"id": "ManagedInstanceVersion",
"properties": {
"instanceTemplate": {
"description": "Output only. [Output Only] The intended template of the instance. This field is empty\nwhen current_action is one of { DELETING, ABANDONING }.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] Name of the version.",
"readOnly": true,
"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\nthe metadata's contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update metadata. You must always provide an\nup-to-date fingerprint hash in order to update or change metadata,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve the resource.",
"format": "byte",
"type": "string"
},
"items": {
"description": "Array of key/value pairs. The total size of all keys and values must be\nless than 512 KB.",
"items": {
"description": "Metadata",
"properties": {
"key": {
"annotations": {
"required": [
"compute.instances.insert",
"compute.projects.setCommonInstanceMetadata"
]
},
"description": "Key for the metadata entry. Keys must conform to the following\nregexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length.\nThis is reflected as part of a URL in the metadata server. Additionally, to\navoid ambiguity, keys must not conflict with any other metadata keys\nfor 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\nhave meaning as interpreted by the image running in the instance. The\nonly restriction placed on values is that their size must be less than\nor equal to 262144 bytes (256 KiB).",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"kind": {
"default": "compute#metadata",
"description": "Output only. [Output Only] Type of the resource. Always compute#metadata\nfor metadata.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"MetadataFilter": {
"description": "Opaque filter criteria used by load balancers to restrict routing\nconfiguration to a limited set of load balancing proxies. Proxies and\nsidecars involved in load balancing would typically present metadata to the\nload balancers that need to match criteria specified here. If a match takes\nplace, the relevant configuration is made available to those\nproxies.\n\nFor each metadataFilter in this list, if itsfilterMatchCriteria is set to MATCH_ANY, at least\none of thefilterLabels must match the corresponding label provided in\nthe metadata. If its filterMatchCriteria is set to\nMATCH_ALL, then all of its filterLabels must match with\ncorresponding labels provided in the metadata.\n\nAn example for using metadataFilters would be: if\nload balancing involves\nEnvoys, they receive routing configuration when values inmetadataFilters match values supplied in  of their XDS requests to loadbalancers.",
"id": "MetadataFilter",
"properties": {
"filterLabels": {
"description": "The list of label value pairs that must match labels in the provided\nmetadata based on filterMatchCriteria\n\nThis list must not be empty and can have at the most 64 entries.",
"items": {
"$ref": "MetadataFilterLabelMatch"
},
"type": "array"
},
"filterMatchCriteria": {
"description": "Specifies how individual filter label matches\nwithin the list of filterLabels and contributes toward the\noverall metadataFilter match.\n\n Supported values are:\n   \n   - MATCH_ANY: at least one of the filterLabels\n   must have a matching label in the provided metadata.\n   - MATCH_ALL: all filterLabels must have\n   matching labels in the provided metadata.",
"enum": [
"MATCH_ALL",
"MATCH_ANY",
"NOT_SET"
],
"enumDescriptions": [
"Specifies that all filterLabels must match for themetadataFilter to be considered a match.",
"Specifies that any filterLabel must match for themetadataFilter to be considered a match.",
"Indicates that the match criteria was not set. AmetadataFilter must never be created with this value."
],
"type": "string"
}
},
"type": "object"
},
"MetadataFilterLabelMatch": {
"description": "MetadataFilter label name value pairs that are expected\nto match corresponding labels presented as metadata to the load balancer.",
"id": "MetadataFilterLabelMatch",
"properties": {
"name": {
"description": "Name of metadata label.\n\n The name can have a maximum length of 1024 characters and must be at\nleast 1 character long.",
"type": "string"
},
"value": {
"description": "The value of the label must match the specified value.\n\nvalue can have a maximum length of 1024 characters.",
"type": "string"
}
},
"type": "object"
},
"NamedPort": {
"description": "The named port. For example: <\"http\", 80>.",
"id": "NamedPort",
"properties": {
"name": {
"description": "The name for this named port.\nThe name must be 1-63 characters long, and comply withRFC1035.",
"type": "string"
},
"port": {
"description": "The port number, which can be a value between 1 and 65535.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"NatIpInfo": {
"description": "Contains NAT IP information of a NAT config (i.e. usage status, mode).",
"id": "NatIpInfo",
"properties": {
"natIpInfoMappings": {
"description": "Output only. A list of all NAT IPs assigned to this NAT config.",
"items": {
"$ref": "NatIpInfoNatIpInfoMapping"
},
"readOnly": true,
"type": "array"
},
"natName": {
"description": "Output only. Name of the NAT config which the NAT IP belongs to.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NatIpInfoNatIpInfoMapping": {
"description": "Contains information of a NAT IP.",
"id": "NatIpInfoNatIpInfoMapping",
"properties": {
"mode": {
"description": "Output only. Specifies whether NAT IP is auto or manual.",
"enum": [
"AUTO",
"MANUAL"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
},
"natIp": {
"description": "Output only. NAT IP address. For example: 203.0.113.11.",
"readOnly": true,
"type": "string"
},
"usage": {
"description": "Output only. Specifies whether NAT IP is currently serving at least one endpoint or\nnot.",
"enum": [
"IN_USE",
"UNUSED"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NatIpInfoResponse": {
"id": "NatIpInfoResponse",
"properties": {
"result": {
"description": "[Output Only] A list of NAT IP information.",
"items": {
"$ref": "NatIpInfo"
},
"type": "array"
}
},
"type": "object"
},
"Network": {
"description": "Represents a VPC Network resource.\n\nNetworks connect resources to each other and to the internet. For more\ninformation, readVirtual Private Cloud (VPC) Network.",
"id": "Network",
"properties": {
"IPv4Range": {
"deprecated": true,
"description": "Deprecated in favor of subnet mode networks.\nThe range of internal addresses that are legal on this network. This\nrange is aCIDR specification, for example:192.168.0.0/16. Provided by the client when the network is\ncreated.",
"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}/[0-9]{1,2}",
"type": "string"
},
"autoCreateSubnetworks": {
"description": "Must be set to create a VPC network. If not set, a legacy network is\ncreated.\n\nWhen set to true, the VPC network is created in auto mode.\nWhen 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\nhas a predetermined range as described inAuto mode VPC network IP ranges.\n\nFor custom mode VPC networks, you can add subnets using the subnetworksinsert\nmethod.",
"type": "boolean"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you\ncreate the resource.",
"type": "string"
},
"enableUlaInternalIpv6": {
"description": "Enable ULA internal ipv6 on this network. Enabling this feature will assign\na /48 from google defined ULA prefix fd20::/20.\n.",
"type": "boolean"
},
"firewallPolicy": {
"description": "Output only. [Output Only] URL of the firewall policy the network is associated with.",
"readOnly": true,
"type": "string"
},
"gatewayIPv4": {
"description": "[Output Only] The gateway address for default routing out of the network,\nselected by Google Cloud.",
"pattern": "[0-9]{1,3}(?:\\.[0-9]{1,3}){3}",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"internalIpv6Range": {
"description": "When enabling ula internal ipv6, caller optionally can specify the /48\nrange they want from the google defined ULA prefix fd20::/20. The input\nmust be a valid /48 ULA IPv6 address and must be within the fd20::/20.\nOperation will fail if the speficied /48 is already in used by another\nresource. If the field is not speficied, then a /48 range will be randomly\nallocated from fd20::/20 and returned via this field.\n.",
"type": "string"
},
"kind": {
"default": "compute#network",
"description": "Output only. [Output Only] Type of the resource. Always compute#network for\nnetworks.",
"readOnly": true,
"type": "string"
},
"mtu": {
"description": "Maximum Transmission Unit in bytes.\nThe minimum value for this field is 1300 and the maximum value is 8896.\nThe suggested value is 1500, which is the default MTU used on the\nInternet, or 8896 if you want to use Jumbo frames. If unspecified, the\nvalue defaults to 1460.",
"format": "int32",
"type": "integer"
},
"name": {
"annotations": {
"required": [
"compute.networks.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a\nlowercase letter, and all following characters (except for the last\ncharacter) must be a dash, lowercase letter, or digit. The last character\nmust be a lowercase letter or digit.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"networkFirewallPolicyEnforcementOrder": {
"description": "The network firewall policy enforcement order. Can be either\nAFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to\nAFTER_CLASSIC_FIREWALL if the field is not specified.",
"enum": [
"AFTER_CLASSIC_FIREWALL",
"BEFORE_CLASSIC_FIREWALL"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"networkProfile": {
"description": "A full or partial URL of the network profile to apply to this network.\nThis field can be set only at resource creation time. For example, the\nfollowing are valid URLs: \n   \n   - https://www.googleapis.com/compute/{api_version}/projects/{project_id}/global/networkProfiles/{network_profile_name}\n   - projects/{project_id}/global/networkProfiles/{network_profile_name}",
"type": "string"
},
"params": {
"$ref": "NetworkParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"peerings": {
"description": "Output only. [Output Only] A list of network peerings for the resource.",
"items": {
"$ref": "NetworkPeering"
},
"readOnly": true,
"type": "array"
},
"routingConfig": {
"$ref": "NetworkRoutingConfig",
"description": "The network-level routing configuration for this network.  Used by Cloud\nRouter to determine what type of network-wide routing behavior to enforce."
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"subnetworks": {
"description": "[Output Only] Server-defined fully-qualified URLs for all subnetworks\nin this VPC network.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NetworkAttachment": {
"description": "NetworkAttachments\nA network attachment resource ...",
"id": "NetworkAttachment",
"properties": {
"connectionEndpoints": {
"description": "Output only. [Output Only] An array of connections for all the producers connected\nto this network attachment.",
"items": {
"$ref": "NetworkAttachmentConnectedEndpoint"
},
"readOnly": true,
"type": "array"
},
"connectionPreference": {
"enum": [
"ACCEPT_AUTOMATIC",
"ACCEPT_MANUAL",
"INVALID"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. An up-to-date\nfingerprint must be provided in order to patch.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#networkAttachment",
"description": "Output only. [Output Only] Type of the resource.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.networkAttachments.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"network": {
"description": "Output only. [Output Only] The URL of the network which the Network Attachment\nbelongs to. Practically it is inferred by fetching the network of the first\nsubnetwork associated. Because it is required that all the subnetworks must\nbe from the same network, it is assured that the Network Attachment belongs\nto the same network as all the subnetworks.",
"readOnly": true,
"type": "string"
},
"producerAcceptLists": {
"description": "Projects that are allowed to connect to this network attachment.\nThe project can be specified using its id or number.",
"items": {
"type": "string"
},
"type": "array"
},
"producerRejectLists": {
"description": "Projects that are not allowed to connect to this network attachment.\nThe project can be specified using its id or number.",
"items": {
"type": "string"
},
"type": "array"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the network attachment resides.\nThis field applies only to the region resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"subnetworks": {
"description": "An array of URLs where each entry is the URL of a subnet\nprovided by the service consumer to use for\nendpoints in the producers that connect to this network attachment.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"NetworkAttachmentAggregatedList": {
"description": "Contains a list of NetworkAttachmentsScopedList.",
"id": "NetworkAttachmentAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NetworkAttachmentsScopedList",
"description": "Name of the scope containing this set of NetworkAttachments."
},
"description": "A list of NetworkAttachmentsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#networkAttachmentAggregatedList",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkAttachmentConnectedEndpoint": {
"description": "[Output Only] A connection connected to this network attachment.",
"id": "NetworkAttachmentConnectedEndpoint",
"properties": {
"ipAddress": {
"description": "The IPv4 address assigned to the producer instance network interface.\nThis value will be a range in case of Serverless.",
"type": "string"
},
"ipv6Address": {
"description": "The IPv6 address assigned to the producer instance network interface.\nThis is only assigned when the stack types of both the instance network\ninterface and the consumer subnet are IPv4_IPv6.",
"type": "string"
},
"projectIdOrNum": {
"description": "The project id or number of the interface to which the IP was assigned.",
"type": "string"
},
"secondaryIpCidrRanges": {
"description": "Alias IP ranges from the same subnetwork.",
"items": {
"type": "string"
},
"type": "array"
},
"serviceClassId": {
"description": "The service class id of the producer service to which the IP was\nassigned.",
"type": "string"
},
"status": {
"description": "The status of a connected endpoint to this network attachment.",
"enum": [
"ACCEPTED",
"CLOSED",
"NEEDS_ATTENTION",
"PENDING",
"REJECTED",
"STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The consumer allows traffic from the producer to reach its VPC.",
"The consumer network attachment no longer exists.",
"The consumer needs to take further action before traffic can be served.",
"The consumer neither allows nor prohibits traffic\nfrom the producer to reach its VPC.",
"The consumer prohibits traffic from the producer to reach its VPC.",
""
],
"type": "string"
},
"subnetwork": {
"description": "The subnetwork used to assign the IP to the producer\ninstance network interface.",
"type": "string"
},
"subnetworkCidrRange": {
"description": "Output only. [Output Only] The CIDR range of the subnet from which the IPv4 internal\nIP was allocated from.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NetworkAttachmentList": {
"id": "NetworkAttachmentList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NetworkAttachment resources.",
"items": {
"$ref": "NetworkAttachment"
},
"type": "array"
},
"kind": {
"default": "compute#networkAttachmentList",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkAttachmentsScopedList": {
"id": "NetworkAttachmentsScopedList",
"properties": {
"networkAttachments": {
"description": "A list of NetworkAttachments contained in this scope.",
"items": {
"$ref": "NetworkAttachment"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nnetwork attachments when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkEdgeSecurityService": {
"description": "Represents a Google Cloud Armor network edge security service resource.",
"id": "NetworkEdgeSecurityService",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be\nprovided in order to update the NetworkEdgeSecurityService,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a NetworkEdgeSecurityService.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#networkEdgeSecurityService",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#networkEdgeSecurityService for\nNetworkEdgeSecurityServices",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the resource resides. You must\nspecify this field as part of the HTTP request URL. It is not settable as a\nfield in the request body.",
"readOnly": true,
"type": "string"
},
"securityPolicy": {
"description": "The resource URL for the network edge security service associated with this\nnetwork edge security service.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NetworkEdgeSecurityServiceAggregatedList": {
"id": "NetworkEdgeSecurityServiceAggregatedList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NetworkEdgeSecurityServicesScopedList",
"description": "Name of the scope containing this set of security policies."
},
"description": "A list of NetworkEdgeSecurityServicesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#networkEdgeSecurityServiceAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#networkEdgeSecurityServiceAggregatedList for lists of\nNetwork Edge Security Services.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkEdgeSecurityServicesScopedList": {
"id": "NetworkEdgeSecurityServicesScopedList",
"properties": {
"networkEdgeSecurityServices": {
"description": "A list of NetworkEdgeSecurityServices contained in this scope.",
"items": {
"$ref": "NetworkEdgeSecurityService"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nsecurity policies when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkEndpoint": {
"description": "The network endpoint.",
"id": "NetworkEndpoint",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional metadata defined as annotations on the network endpoint.",
"type": "object"
},
"clientDestinationPort": {
"description": "Represents the port number to which PSC consumer sends packets.\n\nOptional. Only valid for network endpoint groups created withGCE_VM_IP_PORTMAP endpoint type.",
"format": "int32",
"type": "integer"
},
"fqdn": {
"description": "Optional fully qualified domain name of network endpoint. This can only be\nspecified when NetworkEndpointGroup.network_endpoint_type isNON_GCP_FQDN_PORT.",
"type": "string"
},
"instance": {
"description": "The name or a URL of VM instance of this network endpoint.\nOptional, the field presence depends on the network endpoint type. The\nfield is required for network endpoints of type GCE_VM_IP andGCE_VM_IP_PORT.\n\nThe instance must be in the same zone of network endpoint group (for zonal\nNEGs) or in the zone within the region of the NEG (for regional NEGs).\nIf the ipAddress is specified, it must belongs to the VM\ninstance.\n\nThe name must be 1-63 characters long, and comply withRFC1035\nor be a valid URL pointing to an existing instance.",
"type": "string"
},
"ipAddress": {
"description": "Optional IPv4 address of network endpoint. The IP address must belong to a\nVM in Compute Engine (either the primary IP or as part of an aliased IP\nrange). If the IP address is not specified, then the primary IP address for\nthe VM instance in the network that the network endpoint group belongs to\nwill be used.\n\nThis field is redundant and need not be set for network endpoints of typeGCE_VM_IP. If set, it must be set to the primary internal IP\naddress of the attached VM instance that matches the subnetwork of the NEG.\nThe primary internal IP address from any NIC of a multi-NIC VM instance can\nbe added to a NEG as long as it matches the NEG subnetwork.",
"type": "string"
},
"ipv6Address": {
"description": "Optional IPv6 address of network endpoint.",
"type": "string"
},
"port": {
"description": "Optional port number of network endpoint. If not specified, the\ndefaultPort for the network endpoint group will be used.\n\nThis field can not be set for network endpoints of typeGCE_VM_IP.",
"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\nreached, whether they are reachable, and where they are located.\nFor more information about using NEGs for different use cases, seeNetwork endpoint groups overview.\n\nNote: Use the following APIs to manage network endpoint groups:\n   \n   - \n   To manage NEGs with zonal scope (such as zonal NEGs, hybrid connectivity\n   NEGs): zonal\n   API\n   - \n   To manage NEGs with regional scope (such as regional internet NEGs,\n   serverless NEGs, Private Service Connect NEGs): regional\n   API\n   - \n   To manage NEGs with global scope (such as global internet NEGs):global\n   API",
"id": "NetworkEndpointGroup",
"properties": {
"annotations": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Metadata defined as annotations on the network endpoint group.",
"type": "object"
},
"appEngine": {
"$ref": "NetworkEndpointGroupAppEngine",
"description": "Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set."
},
"cloudFunction": {
"$ref": "NetworkEndpointGroupCloudFunction",
"description": "Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set."
},
"cloudRun": {
"$ref": "NetworkEndpointGroupCloudRun",
"description": "Optional. Only valid when networkEndpointType isSERVERLESS. Only one of cloudRun,appEngine or cloudFunction may be set."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"defaultPort": {
"description": "The default port used if the port number is not specified in the network\nendpoint.\n\nOptional. If the network endpoint type is either GCE_VM_IP,SERVERLESS or PRIVATE_SERVICE_CONNECT, this\nfield must not be specified.",
"format": "int32",
"type": "integer"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#networkEndpointGroup",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#networkEndpointGroup for network endpoint group.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"type": "string"
},
"network": {
"description": "The URL of the network to which all network endpoints in the NEG belong.\nUses default project network if unspecified.",
"type": "string"
},
"networkEndpointType": {
"description": "Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.",
"enum": [
"GCE_VM_IP",
"GCE_VM_IP_PORT",
"GCE_VM_IP_PORTMAP",
"INTERNET_FQDN_PORT",
"INTERNET_IP_PORT",
"NON_GCP_PRIVATE_IP_PORT",
"PRIVATE_SERVICE_CONNECT",
"SERVERLESS"
],
"enumDescriptions": [
"The network endpoint is represented by an IP address.",
"The network endpoint is represented by IP address and port pair.",
"The network endpoint is represented by an IP, Port and Client Destination\nPort.",
"The network endpoint is represented by fully qualified domain name and\nport.",
"The network endpoint is represented by an internet IP address and port.",
"The network endpoint is represented by an IP address and port. The\nendpoint belongs to a VM or pod running in a customer's on-premises.",
"The network endpoint is either public Google APIs or\nservices exposed by other GCP Project with a Service Attachment.\nThe connection is set up by private service connect",
"The network endpoint is handled by specified serverless infrastructure."
],
"type": "string"
},
"pscData": {
"$ref": "NetworkEndpointGroupPscData",
"description": "Optional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT."
},
"pscTargetService": {
"description": "The target service url used to set up private service connection to\na Google API or a PSC Producer Service Attachment.\nAn example value is: asia-northeast3-cloudkms.googleapis.com.\n\nOptional. Only valid when networkEndpointType isPRIVATE_SERVICE_CONNECT.",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] The URL of theregion\nwhere the network endpoint group is located.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"size": {
"description": "Output only. [Output only] Number of network endpoints in the network endpoint group.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"subnetwork": {
"description": "Optional URL of the subnetwork to which all network endpoints in the NEG\nbelong.",
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] The URL of thezone\nwhere the network endpoint group is located.",
"readOnly": true,
"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. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupAggregatedList for aggregated\nlists of network endpoint groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkEndpointGroupAppEngine": {
"description": "Configuration for an App Engine network endpoint group (NEG).\nThe service is optional, may be provided explicitly or in the\nURL mask. The version is optional and can only be provided\nexplicitly or in the URL mask when service is present.\n\nNote: App Engine service must be in the same project and located in the\nsame region as the Serverless NEG.",
"id": "NetworkEndpointGroupAppEngine",
"properties": {
"service": {
"description": "Optional serving service.\n\nThe service name is case-sensitive and must be 1-63\ncharacters long.\n\nExample value: default, my-service.",
"type": "string"
},
"urlMask": {
"description": "An URL\nmask is one of the main components of the Cloud Function.\n\nA template to parse service and version fields\nfrom a request URL. URL mask allows for routing to multiple App Engine\nservices without having to create multiple Network Endpoint Groups and\nbackend services.\n\nFor example, the request URLsfoo1-dot-appname.appspot.com/v1 andfoo1-dot-appname.appspot.com/v2 can be backed by the same\nServerless NEG with URL mask<service>-dot-appname.appspot.com/<version>.\nThe URL mask will parse them to { service = \"foo1\", version = \"v1\"\n} and { service = \"foo1\", version = \"v2\" }\nrespectively.",
"type": "string"
},
"version": {
"description": "Optional serving version.\n\nThe version name is case-sensitive and must be 1-100\ncharacters long.\n\nExample value: v1, v2.",
"type": "string"
}
},
"type": "object"
},
"NetworkEndpointGroupCloudFunction": {
"description": "Configuration for a Cloud Function network endpoint group (NEG).\nThe function must be provided explicitly or in the URL mask.\n\nNote: Cloud Function must be in the same project and located in the same\nregion as the Serverless NEG.",
"id": "NetworkEndpointGroupCloudFunction",
"properties": {
"function": {
"description": "A user-defined name of the Cloud Function.\n\nThe function name is case-sensitive and must be 1-63\ncharacters long.\n\nExample value: func1.",
"type": "string"
},
"urlMask": {
"description": "An URL\nmask is one of the main components of the Cloud Function.\n\nA template to parse function field from a request URL. URL\nmask allows for routing to multiple Cloud Functions without having to\ncreate multiple Network Endpoint Groups and backend services.\n\nFor example, request URLs mydomain.com/function1 andmydomain.com/function2 can be backed by the same\nServerless NEG with URL mask /<function>. The URL\nmask will parse them to { function = \"function1\" } and{ function = \"function2\" } respectively.",
"type": "string"
}
},
"type": "object"
},
"NetworkEndpointGroupCloudRun": {
"description": "Configuration for a Cloud Run network endpoint group (NEG).\nThe service must be provided explicitly or in the URL mask.\nThe tag is optional, may be provided explicitly or in the URL\nmask.\n\nNote: Cloud Run service must be in the same project and located in the same\nregion as the Serverless NEG.",
"id": "NetworkEndpointGroupCloudRun",
"properties": {
"service": {
"description": "Cloud Run service is the main resource of Cloud Run.\n\nThe service must be 1-63 characters long, and comply withRFC1035.\n\nExample value: \"run-service\".",
"type": "string"
},
"tag": {
"description": "Optional Cloud Run tag represents the \"named-revision\" to provide additional\nfine-grained traffic routing information.\n\nThe tag must be 1-63 characters long, and comply withRFC1035.\n\nExample value: \"revision-0010\".",
"type": "string"
},
"urlMask": {
"description": "An URL\nmask is one of the main components of the Cloud Function.\n\nA template to parse <service> and<tag> fields from a request URL. URL mask allows for\nrouting to multiple Run services without having to create multiple\nnetwork endpoint groups and backend services.\n\nFor example, request URLs foo1.domain.com/bar1 andfoo1.domain.com/bar2 can be backed by the same Serverless\nNetwork Endpoint Group (NEG) with URL mask<tag>.domain.com/<service>. The URL mask will\nparse them to { service=\"bar1\", tag=\"foo1\" } and {\nservice=\"bar2\", tag=\"foo2\" } respectively.",
"type": "string"
}
},
"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. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupList for network endpoint group\nlists.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkEndpointGroupPscData": {
"description": "All data that is specifically relevant to only network endpoint groups of\ntype PRIVATE_SERVICE_CONNECT.",
"id": "NetworkEndpointGroupPscData",
"properties": {
"consumerPscAddress": {
"description": "Output only. [Output Only] Address allocated from given subnetwork for PSC. This IP\naddress acts as a VIP for a PSC NEG, allowing it to act as an endpoint in\nL7 PSC-XLB.",
"readOnly": true,
"type": "string"
},
"producerPort": {
"description": "The psc producer port is used to connect PSC NEG with specific port on\nthe PSC Producer side; should only be used for the\nPRIVATE_SERVICE_CONNECT NEG type",
"format": "int32",
"type": "integer"
},
"pscConnectionId": {
"description": "Output only. [Output Only] The PSC connection id of the PSC Network Endpoint Group\nConsumer.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"pscConnectionStatus": {
"description": "Output only. [Output Only] The connection status of the PSC Forwarding Rule.",
"enum": [
"ACCEPTED",
"CLOSED",
"NEEDS_ATTENTION",
"PENDING",
"REJECTED",
"STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The connection has been accepted by the producer.",
"The connection has been closed by the producer and will not serve\ntraffic going forward.",
"The connection has been accepted by the producer, but the producer\nneeds to take further action before the forwarding rule can serve\ntraffic.",
"The connection is pending acceptance by the producer.",
"The connection has been rejected by the producer.",
""
],
"readOnly": true,
"type": "string"
}
},
"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\nendpoint. Valid options are SKIP or SHOW. If you\ndon't specify this parameter, the health status of network endpoints will\nnot be provided.",
"enum": [
"SHOW",
"SKIP"
],
"enumDescriptions": [
"Show the health status for each network endpoint. Impacts latency of the\ncall.",
"Health status for network endpoints will not be provided."
],
"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. [Output Only] The resource type, which is alwayscompute#networkEndpointGroupsListNetworkEndpoints for the list\nof network endpoints in the specified network endpoint group.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] The list ofnetwork\nendpoint groups that are contained in this scope.",
"items": {
"$ref": "NetworkEndpointGroup"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. [Output Only] An informational warning that replaces the list of network\nendpoint groups when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"NetworkEndpointWithHealthStatus": {
"id": "NetworkEndpointWithHealthStatus",
"properties": {
"healths": {
"description": "Output only. [Output only] The health status of network endpoint.\n\nOptional. Displayed only if the network endpoint has centralized health\nchecking configured.",
"items": {
"$ref": "HealthStatusForNetworkEndpoint"
},
"readOnly": true,
"type": "array"
},
"networkEndpoint": {
"$ref": "NetworkEndpoint",
"description": "Output only. [Output only] The network endpoint.",
"readOnly": true
}
},
"type": "object"
},
"NetworkFirewallPolicyAggregatedList": {
"id": "NetworkFirewallPolicyAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "FirewallPoliciesScopedList",
"description": "Name of the scope containing this set of addresses."
},
"description": "A list of FirewallPoliciesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#networkFirewallPolicyAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#networkFirewallPoliciesAggregatedList for lists of\nnetwork firewall policies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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\nconfig, ONE_TO_ONE_NAT, is supported. If there are noaccessConfigs specified, then this instance will have\nno external internet access.",
"items": {
"$ref": "AccessConfig"
},
"type": "array"
},
"aliasIpRanges": {
"description": "An array of alias IP ranges for this network interface.\nYou can only specify this field for network interfaces in VPC networks.",
"items": {
"$ref": "AliasIpRange"
},
"type": "array"
},
"enableVpcScopedDns": {
"description": "Optional. If true, DNS resolution will be enabled over this interface. Only valid\nwith network_attachment.",
"type": "boolean"
},
"fingerprint": {
"description": "Fingerprint hash of contents stored in this network interface.\nThis field will be ignored when inserting an Instance or\nadding a NetworkInterface. An up-to-date\nfingerprint must be provided in order to update theNetworkInterface. The request will fail with error400 Bad Request if the fingerprint is not provided, or412 Precondition Failed if the fingerprint is out of date.",
"format": "byte",
"type": "string"
},
"igmpQuery": {
"description": "Indicate whether igmp query is enabled on the network interface\nor not. If enabled, also indicates the version of IGMP supported.",
"enum": [
"IGMP_QUERY_DISABLED",
"IGMP_QUERY_V2"
],
"enumDescriptions": [
"The network interface has disabled IGMP query.",
"The network interface has enabled IGMP query - v2."
],
"type": "string"
},
"internalIpv6PrefixLength": {
"description": "The prefix length of the primary internal IPv6 range.",
"format": "int32",
"type": "integer"
},
"ipv6AccessConfigs": {
"description": "An array of IPv6 access configurations for this interface. Currently, only\none IPv6 access config, DIRECT_IPV6, is supported. If there\nis no ipv6AccessConfig specified, then this instance will\nhave no external IPv6 Internet access.",
"items": {
"$ref": "AccessConfig"
},
"type": "array"
},
"ipv6AccessType": {
"description": "Output only. [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be\naccessed from the Internet. This field is always inherited from its\nsubnetwork.\n\nValid only if stackType is IPV4_IPV6.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"This network interface can have external IPv6.",
"This network interface can have internal IPv6."
],
"readOnly": true,
"type": "string"
},
"ipv6Address": {
"description": "An IPv6 internal network address for this network interface. To\nuse a static internal IP address, it must be unused and in the same region\nas the instance's zone. If not specified, Google Cloud will automatically\nassign an internal IPv6 address from the instance's subnetwork.",
"type": "string"
},
"kind": {
"default": "compute#networkInterface",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#networkInterface for network interfaces.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "[Output Only] The name of the network interface, which is generated by the\nserver. For a VM, the network interface uses the nicN naming\nformat. Where N is a value between 0 and7. The default interface value is nic0.",
"type": "string"
},
"network": {
"description": "URL of the VPC network resource for this instance. When creating an\ninstance, if neither the network nor the subnetwork is specified, the\ndefault network global/networks/default is used. If the\nselected project doesn't have the default network, you must specify a\nnetwork or subnet. If the network is not specified but the subnetwork is\nspecified, the network is inferred.\n\nIf you specify this property, you can specify the network as\na full or partial URL. For example, the following are all valid URLs:\n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/global/networks/network\n      - projects/project/global/networks/network\n      - global/networks/default",
"type": "string"
},
"networkAttachment": {
"description": "The URL of the network attachment that this interface should connect\nto in the following format:\nprojects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.",
"type": "string"
},
"networkIP": {
"description": "An IPv4 internal IP address to assign to the instance for this network\ninterface. If not specified by the user, an unused internal IP is\nassigned by the system.",
"type": "string"
},
"nicType": {
"description": "The type of vNIC to be used on this interface. This may be gVNIC or\nVirtioNet.",
"enum": [
"GVNIC",
"IDPF",
"IRDMA",
"MRDMA",
"UNSPECIFIED_NIC_TYPE",
"VIRTIO_NET"
],
"enumDescriptions": [
"GVNIC",
"IDPF",
"IRDMA",
"MRDMA",
"No type specified.",
"VIRTIO"
],
"type": "string"
},
"parentNicName": {
"description": "Name of the parent network interface of a dynamic network interface.",
"type": "string"
},
"queueCount": {
"description": "The networking queue count that's specified by users for the network\ninterface. Both Rx and Tx queues will be set to this number. It'll be empty\nif not specified by the users.",
"format": "int32",
"type": "integer"
},
"serviceClassId": {
"description": "Optional. Producer Service's Service class Id for the region of this network\ninterface. Can only be used with network_attachment. It is not possible to\nuse on its own however, network_attachment can be used without\nservice_class_id.",
"type": "string"
},
"stackType": {
"description": "The stack type for this network interface. To assign only IPv4 addresses,\nuse IPV4_ONLY. To assign both IPv4 and IPv6 addresses, useIPV4_IPV6. If not specified, IPV4_ONLY is used.\n\nThis field can be both set at instance creation and update network\ninterface operations.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY",
"IPV6_ONLY"
],
"enumDescriptions": [
"The network interface can have both IPv4 and IPv6 addresses.",
"The network interface will only be assigned IPv4 addresses.",
"The network interface will only be assigned IPv6 addresses."
],
"type": "string"
},
"subnetwork": {
"description": "The URL of the Subnetwork resource for this instance. If the network\nresource is inlegacy\nmode, do not specify this field. If the network is in auto subnet\nmode, specifying the subnetwork is optional. If the network is in custom\nsubnet mode, specifying the subnetwork is required. If you specify this\nfield, you can specify the subnetwork as a full or partial URL. For\nexample, the following are all valid URLs:\n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork \n   - regions/region/subnetworks/subnetwork",
"type": "string"
},
"vlan": {
"description": "VLAN tag of a dynamic network interface, must be  an integer in the range\nfrom 2 to 255 inclusively.",
"format": "int32",
"type": "integer"
}
},
"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. [Output Only] Type of resource. Always compute#networkList for\nlists of networks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkParams": {
"description": "Additional network parameters.",
"id": "NetworkParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"NetworkPeering": {
"description": "A network peering attached to a network resource. The message includes the\npeering name, peer network, peering state, and a flag indicating whether\nGoogle Compute Engine should automatically create routes for the peering.",
"id": "NetworkPeering",
"properties": {
"autoCreateRoutes": {
"description": "This field will be deprecated soon. Use theexchange_subnet_routes field instead.\nIndicates whether full mesh connectivity is created and managed\nautomatically between peered networks. Currently this field should always\nbe true since Google Compute Engine will automatically create and manage\nsubnetwork routes between two networks when peering state isACTIVE.",
"type": "boolean"
},
"connectionStatus": {
"$ref": "NetworkPeeringConnectionStatus",
"description": "Output only. [Output Only] The effective state of the peering connection\nas a whole.",
"readOnly": true
},
"exchangeSubnetRoutes": {
"description": "Indicates whether full mesh connectivity is created and managed\nautomatically between peered networks. Currently this field should always\nbe true since Google Compute Engine will automatically create and manage\nsubnetwork routes between two networks when peering state isACTIVE.",
"type": "boolean"
},
"exportCustomRoutes": {
"description": "Whether to export the custom routes to peer network. The default value is\nfalse.",
"type": "boolean"
},
"exportSubnetRoutesWithPublicIp": {
"description": "Whether subnet routes with public IP range are exported. The default value\nis true, all subnet routes are exported.IPv4\nspecial-use ranges are always\nexported to peers and are not controlled by this field.",
"type": "boolean"
},
"importCustomRoutes": {
"description": "Whether to import the custom routes from peer network. The default value is\nfalse.",
"type": "boolean"
},
"importSubnetRoutesWithPublicIp": {
"description": "Whether subnet routes with public IP range are imported. The default value\nis false.IPv4\nspecial-use ranges are always\nimported 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.\nThe name must comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a\nlowercase letter, and all the following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.",
"type": "string"
},
"network": {
"description": "The URL of the peer network. It can be either full URL or partial URL. The\npeer network may belong to a different project. If the partial URL does not\ncontain project, it is assumed that the peer network is in the same project\nas the current network.",
"type": "string"
},
"peerMtu": {
"description": "Output only. [Output Only] Maximum Transmission Unit in bytes of the peer network.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"stackType": {
"description": "Which IP version(s) of traffic and routes are allowed to be imported or\nexported between peer networks. The default value is IPV4_ONLY.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY"
],
"enumDescriptions": [
"This Peering will allow IPv4 traffic and routes to be\nexchanged. Additionally if the matching peering is\nIPV4_IPV6, IPv6 traffic and routes will be exchanged as\nwell.",
"This Peering will only allow IPv4 traffic and routes to be\nexchanged, even if the matching peering is IPV4_IPV6."
],
"type": "string"
},
"state": {
"description": "Output only. [Output Only] State for the peering.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"enumDescriptions": [
"Matching configuration exists on the peer.",
"There is no matching configuration on the peer, including the case when\npeer does not exist."
],
"readOnly": true,
"type": "string"
},
"stateDetails": {
"description": "Output only. [Output Only] Details about the current state of the peering.",
"readOnly": true,
"type": "string"
},
"updateStrategy": {
"description": "The update strategy determines the semantics for updates and deletes to the\npeering connection configuration.",
"enum": [
"CONSENSUS",
"INDEPENDENT",
"UNSPECIFIED"
],
"enumDescriptions": [
"Updates are reflected in the local peering but aren't applied to the\npeering connection until a complementary change is made to the\nmatching peering.\nTo delete a peering with the consensus update strategy, both the peerings\nmust request the deletion of the peering before the peering can be\ndeleted.",
"In this mode, changes to the peering configuration can\nbe unilaterally altered by changing either side of the peering.\nThis is the default value if the field is unspecified.",
"Peerings with update strategy UNSPECIFIED are created with\nupdate strategy INDEPENDENT."
],
"type": "string"
}
},
"type": "object"
},
"NetworkPeeringConnectionStatus": {
"description": "[Output Only] Describes the state of a peering connection, not just the\nlocal peering. This field provides information about the effective settings\nfor the connection as a whole, including pending delete/update requests for\nCONSENSUS peerings.",
"id": "NetworkPeeringConnectionStatus",
"properties": {
"consensusState": {
"$ref": "NetworkPeeringConnectionStatusConsensusState",
"description": "The consensus state contains information about the status of update\nand delete for a consensus peering connection."
},
"trafficConfiguration": {
"$ref": "NetworkPeeringConnectionStatusTrafficConfiguration",
"description": "The active connectivity settings for the peering connection based on the\nsettings of the network peerings."
},
"updateStrategy": {
"description": "The update strategy determines the update/delete semantics for this\npeering connection.",
"enum": [
"CONSENSUS",
"INDEPENDENT",
"UNSPECIFIED"
],
"enumDescriptions": [
"Updates are reflected in the local peering but aren't applied to the\npeering connection until a complementary change is made to the\nmatching peering.\nTo delete a peering with the consensus update strategy, both the peerings\nmust request the deletion of the peering before the peering can be\ndeleted.",
"In this mode, changes to the peering configuration can\nbe unilaterally altered by changing either side of the peering.\nThis is the default value if the field is unspecified.",
"Peerings with update strategy UNSPECIFIED are created with\nupdate strategy INDEPENDENT."
],
"type": "string"
}
},
"type": "object"
},
"NetworkPeeringConnectionStatusConsensusState": {
"description": "The status of update/delete for a consensus peering connection. Only set\nwhen connection_status.update_strategy isCONSENSUS or a network peering is proposing to update the\nstrategy to CONSENSUS.",
"id": "NetworkPeeringConnectionStatusConsensusState",
"properties": {
"deleteStatus": {
"description": "The status of the delete request.",
"enum": [
"DELETE_ACKNOWLEDGED",
"DELETE_STATUS_UNSPECIFIED",
"LOCAL_CANCEL_REQUESTED",
"LOCAL_DELETE_REQUESTED",
"PEER_CANCEL_REQUESTED",
"PEER_DELETE_REQUESTED"
],
"enumDescriptions": [
"Both network admins have agreed this consensus peering connection can\nbe deleted.",
"",
"The local network admin requested to cancel their delete request\nafter DELETE_ACKNOWLEDGED.",
"Network admin has requested deletion of this peering connection.",
"The peer network admin requested to cancel their delete request after\nDELETE_ACKNOWLEDGED.",
"The peer network admin has requested deletion of this peering\nconnection."
],
"type": "string"
},
"updateStatus": {
"description": "The status of the update request.",
"enum": [
"IN_SYNC",
"PENDING_LOCAL_ACKNOWLEDMENT",
"PENDING_PEER_ACKNOWLEDGEMENT",
"UPDATE_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"No pending configuration update proposals to the  peering connection.",
"The peer network admin has made an updatePeering call. The change is\nawaiting acknowledgment from this peering's network admin.",
"The local network admin has made an updatePeering call. The change\nis awaiting acknowledgment from the peer network admin.",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworkPeeringConnectionStatusTrafficConfiguration": {
"id": "NetworkPeeringConnectionStatusTrafficConfiguration",
"properties": {
"exportCustomRoutesToPeer": {
"description": "Whether custom routes are being exported to the peer network.",
"type": "boolean"
},
"exportSubnetRoutesWithPublicIpToPeer": {
"description": "Whether subnet routes with public IP ranges are being exported to the\npeer network.",
"type": "boolean"
},
"importCustomRoutesFromPeer": {
"description": "Whether custom routes are being imported from the peer network.",
"type": "boolean"
},
"importSubnetRoutesWithPublicIpFromPeer": {
"description": "Whether subnet routes with public IP ranges are being imported\nfrom the peer network.",
"type": "boolean"
},
"stackType": {
"description": "Which IP version(s) of traffic and routes are being imported or\nexported between peer networks.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY"
],
"enumDescriptions": [
"This Peering will allow IPv4 traffic and routes to be\nexchanged. Additionally if the matching peering is\nIPV4_IPV6, IPv6 traffic and routes will be exchanged as\nwell.",
"This Peering will only allow IPv4 traffic and routes to be\nexchanged, even if the matching peering is IPV4_IPV6."
],
"type": "string"
}
},
"type": "object"
},
"NetworkPerformanceConfig": {
"id": "NetworkPerformanceConfig",
"properties": {
"totalEgressBandwidthTier": {
"enum": [
"DEFAULT",
"TIER_1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworkProfile": {
"description": "NetworkProfile represents a Google managed network profile resource.",
"id": "NetworkProfile",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. [Output Only] An optional description of this resource.",
"readOnly": true,
"type": "string"
},
"features": {
"$ref": "NetworkProfileNetworkFeatures",
"description": "Output only. [Output Only] Features supported by the network.",
"readOnly": true
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#networkProfile",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#networkProfile for network profiles.",
"readOnly": true,
"type": "string"
},
"location": {
"$ref": "NetworkProfileLocation",
"description": "Output only. [Output Only] Location to which the network is restricted.",
"readOnly": true
},
"name": {
"description": "Output only. [Output Only] Name of the resource.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"readOnly": true,
"type": "string"
},
"profileType": {
"$ref": "NetworkProfileProfileType",
"description": "Output only. [Output Only] Type of the network profile.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NetworkProfileLocation": {
"id": "NetworkProfileLocation",
"properties": {
"name": {
"type": "string"
},
"scope": {
"enum": [
"REGION",
"ZONE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworkProfileNetworkFeatures": {
"id": "NetworkProfileNetworkFeatures",
"properties": {
"addressPurposes": {
"description": "Specifies what address purposes are supported. If empty, all address\npurposes are supported.",
"items": {
"enum": [
"DNS_RESOLVER",
"GCE_ENDPOINT",
"IPSEC_INTERCONNECT",
"NAT_AUTO",
"PRIVATE_SERVICE_CONNECT",
"SERVERLESS",
"SHARED_LOADBALANCER_VIP",
"VPC_PEERING"
],
"enumDescriptions": [
"DNS resolver address in the subnetwork.",
"VM internal/alias IP, Internal LB service IP, etc.",
"A regional internal IP address range reserved for the VLAN attachment\nthat is used in HA VPN over Cloud Interconnect. This regional\ninternal IP address range must not overlap with any IP address range\nof subnet/route in the VPC network and its peering networks. After the\nVLAN attachment is created with the reserved IP address range, when\ncreating a new VPN gateway, its interface IP address is allocated\nfrom the associated VLAN attachment\u2019s IP address range.",
"External IP automatically reserved for Cloud NAT.",
"A private network IP address that can be used to configure Private\nService Connect. This purpose can be specified only forGLOBAL addresses of Type INTERNAL",
"A regional internal IP address range reserved for Serverless.",
"A private network IP address that can be shared by multiple Internal\nLoad Balancer forwarding rules.",
"IP range for peer networks."
],
"type": "string"
},
"type": "array"
},
"allowAddressCreation": {
"description": "Specifies whether address creation is allowed.",
"enum": [
"ADDRESS_CREATION_ALLOWED",
"ADDRESS_CREATION_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowAliasIpRanges": {
"description": "Specifies whether alias IP ranges (and secondary address ranges) are\nallowed.",
"enum": [
"ALIAS_IP_RANGES_ALLOWED",
"ALIAS_IP_RANGES_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowAutoModeSubnet": {
"description": "Specifies whether auto mode subnet creation is allowed.",
"enum": [
"AUTO_MODE_SUBNET_ALLOWED",
"AUTO_MODE_SUBNET_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowClassDFirewalls": {
"description": "Specifies whether firewalls for Class D address ranges are supported.",
"enum": [
"CLASS_D_FIREWALLS_ALLOWED",
"CLASS_D_FIREWALLS_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowCloudNat": {
"description": "Specifies whether cloud NAT creation is allowed.",
"enum": [
"CLOUD_NAT_ALLOWED",
"CLOUD_NAT_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowCloudRouter": {
"description": "Specifies whether cloud router creation is allowed.",
"enum": [
"CLOUD_ROUTER_ALLOWED",
"CLOUD_ROUTER_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowDefaultNicAttachment": {
"description": "Specifies whether default NIC attachment is allowed.",
"enum": [
"DEFAULT_NIC_ATTACHMENT_ALLOWED",
"DEFAULT_NIC_ATTACHMENT_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowExternalIpAccess": {
"description": "Specifies whether VMs are allowed to have external IP access on network\ninterfaces connected to this VPC.",
"enum": [
"EXTERNAL_IP_ACCESS_ALLOWED",
"EXTERNAL_IP_ACCESS_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowFirewallPolicy": {
"description": "Specifies whether firewall policy can be attached to the network.",
"enum": [
"FIREWALL_POLICY_ALLOWED",
"FIREWALL_POLICY_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowInterconnect": {
"description": "Specifies whether Cloud Interconnect creation is allowed.",
"enum": [
"INTERCONNECT_ALLOWED",
"INTERCONNECT_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowIpForwarding": {
"description": "Specifies whether IP forwarding is allowed.",
"enum": [
"IP_FORWARDING_ALLOWED",
"IP_FORWARDING_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowLoadBalancing": {
"description": "Specifies whether cloud load balancing is allowed.",
"enum": [
"LOAD_BALANCING_ALLOWED",
"LOAD_BALANCING_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowMultiNicInSameNetwork": {
"description": "Specifies whether multi-nic in the same network is allowed.",
"enum": [
"MULTI_NIC_IN_SAME_NETWORK_ALLOWED",
"MULTI_NIC_IN_SAME_NETWORK_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowMultiNicInSameSubnetwork": {
"description": "Specifies whether multi-nic in the same subnetwork is allowed.",
"enum": [
"MULTI_NIC_IN_SAME_SUBNETWORK_ALLOWED",
"MULTI_NIC_IN_SAME_SUBNETWORK_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowMulticast": {
"description": "Specifies whether multicast is allowed.",
"enum": [
"MULTICAST_ALLOWED",
"MULTICAST_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowNcc": {
"description": "Specifies whether NCC is allowed.",
"enum": [
"NCC_ALLOWED",
"NCC_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowNetworkMigration": {
"description": "Specifies whether VM network migration is allowed.",
"enum": [
"NETWORK_MIGRATION_ALLOWED",
"NETWORK_MIGRATION_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowPacketMirroring": {
"description": "Specifies whether Packet Mirroring 1.0 is supported.",
"enum": [
"PACKET_MIRRORING_ALLOWED",
"PACKET_MIRRORING_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowPrivateGoogleAccess": {
"description": "Specifies whether private Google access is allowed.",
"enum": [
"PRIVATE_GOOGLE_ACCESS_ALLOWED",
"PRIVATE_GOOGLE_ACCESS_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowPsc": {
"description": "Specifies whether PSC creation is allowed.",
"enum": [
"PSC_ALLOWED",
"PSC_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowSameNetworkUnicast": {
"description": "Specifies whether unicast within the same network is allowed.",
"enum": [
"SAME_NETWORK_UNICAST_ALLOWED",
"SAME_NETWORK_UNICAST_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowStaticRoutes": {
"description": "Specifies whether static route creation is allowed.",
"enum": [
"STATIC_ROUTES_ALLOWED",
"STATIC_ROUTES_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowSubInterfaces": {
"description": "Specifies whether sub interfaces are allowed.",
"enum": [
"SUBINTERFACES_ALLOWED",
"SUBINTERFACES_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowSubnetworkCreation": {
"description": "Specifies whether subnetwork creation is allowed.",
"enum": [
"SUBNETWORK_CREATION_ALLOWED",
"SUBNETWORK_CREATION_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowVpcFirewallRules": {
"description": "Specifies whether VPC firewall rules can be created under the network.",
"enum": [
"VPC_FIREWALL_RULES_ALLOWED",
"VPC_FIREWALL_RULES_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowVpcPeering": {
"description": "Specifies whether VPC peering is allowed.",
"enum": [
"VPC_PEERING_ALLOWED",
"VPC_PEERING_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"allowVpn": {
"description": "Specifies whether VPN creation is allowed.",
"enum": [
"VPN_ALLOWED",
"VPN_BLOCKED"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"firewallPolicyTypes": {
"items": {
"enum": [
"RDMA_ROCE_POLICY",
"ULL_POLICY",
"VPC_POLICY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array"
},
"interfaceTypes": {
"description": "If set, limits the interface types that the network supports. If\nempty, all interface types are supported.",
"items": {
"enum": [
"GVNIC",
"IDPF",
"IRDMA",
"MRDMA",
"UNSPECIFIED_NIC_TYPE",
"VIRTIO_NET"
],
"enumDescriptions": [
"GVNIC",
"IDPF",
"IRDMA",
"MRDMA",
"No type specified.",
"VIRTIO"
],
"type": "string"
},
"type": "array"
},
"multicast": {
"description": "Specifies which type of multicast is supported.",
"enum": [
"MULTICAST_SDN",
"MULTICAST_ULL"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"predefinedNetworkInternalIpv6Range": {
"description": "Specifies a predefined internal IPv6 range for the network.",
"type": "string"
},
"predefinedSubnetworkRanges": {
"description": "Predefined subnetwork ranges for the network.",
"items": {
"$ref": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange"
},
"type": "array"
},
"subnetPurposes": {
"description": "Specifies which subnetwork purposes are supported.",
"items": {
"enum": [
"SUBNET_PURPOSE_CUSTOM_HARDWARE",
"SUBNET_PURPOSE_PRIVATE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"type": "array"
},
"subnetStackTypes": {
"description": "Specifies which subnetwork stack types are supported.",
"items": {
"enum": [
"SUBNET_STACK_TYPE_IPV4_IPV6",
"SUBNET_STACK_TYPE_IPV4_ONLY",
"SUBNET_STACK_TYPE_IPV6_ONLY"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array"
},
"subnetworkPurposes": {
"description": "Output only. Specifies which subnetwork purposes are supported.",
"items": {
"enum": [
"GLOBAL_MANAGED_PROXY",
"INTERNAL_HTTPS_LOAD_BALANCER",
"PEER_MIGRATION",
"PRIVATE",
"PRIVATE_NAT",
"PRIVATE_RFC_1918",
"PRIVATE_SERVICE_CONNECT",
"REGIONAL_MANAGED_PROXY"
],
"enumDescriptions": [
"Subnet reserved for Global Envoy-based Load Balancing.",
"Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy\npurpose, please use REGIONAL_MANAGED_PROXY instead.",
"Subnetwork will be used for Migration from one peered VPC to another.\n(a transient state of subnetwork\nwhile migrating resources from one project to another).",
"Regular user created or automatically created subnet.",
"Subnetwork used as source range for Private NAT Gateways.",
"Regular user created or automatically created subnet.",
"Subnetworks created for Private Service Connect in the producer network.",
"Subnetwork used for Regional Envoy-based Load Balancing."
],
"type": "string"
},
"readOnly": true,
"type": "array"
},
"subnetworkStackTypes": {
"description": "Output only. Specifies which subnetwork stack types are supported.",
"items": {
"enum": [
"IPV4_IPV6",
"IPV4_ONLY",
"IPV6_ONLY"
],
"enumDescriptions": [
"New VMs in this subnet can have both IPv4 and IPv6 addresses.",
"New VMs in this subnet will only be assigned IPv4 addresses.",
"New VMs in this subnet will only  be assigned IPv6 addresses."
],
"type": "string"
},
"readOnly": true,
"type": "array"
},
"unicast": {
"description": "Specifies which type of unicast is supported.",
"enum": [
"UNICAST_SDN",
"UNICAST_ULL"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"NetworkProfileNetworkFeaturesPredefinedSubnetworkRange": {
"id": "NetworkProfileNetworkFeaturesPredefinedSubnetworkRange",
"properties": {
"ipv6Range": {
"description": "The IPv6 range of the predefined subnetwork.",
"type": "string"
},
"namePrefix": {
"description": "The naming prefix of the predefined subnetwork.",
"type": "string"
}
},
"type": "object"
},
"NetworkProfileProfileType": {
"id": "NetworkProfileProfileType",
"properties": {
"networkType": {
"enum": [
"RDMA",
"ULL",
"VPC"
],
"enumDescriptions": [
"RDMA network.",
"ULL network.",
"VPC network."
],
"type": "string"
},
"rdmaSubtype": {
"enum": [
"FALCON",
"ROCE",
"ROCE_METAL"
],
"enumDescriptions": [
"RDMA over Falcon.",
"RDMA over Converged Ethernet (RoCE).",
"RDMA over Converged Ethernet (RoCE) for Bare Metal."
],
"type": "string"
},
"ullSubtype": {
"enum": [
"OPERATOR",
"PARTICIPANT"
],
"enumDescriptions": [
"Exchange operator.",
"Exchange participant."
],
"type": "string"
},
"vpcSubtype": {
"enum": [
"REGIONAL"
],
"enumDescriptions": [
"Regionally bound VPC network."
],
"type": "string"
}
},
"type": "object"
},
"NetworkProfilesListResponse": {
"description": "Contains a list of network profiles.",
"id": "NetworkProfilesListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NetworkProfile resources.",
"items": {
"$ref": "NetworkProfile"
},
"type": "array"
},
"kind": {
"default": "compute#networkProfileList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#networkProfileList for network profiles.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value\nfor\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken\nto\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NetworkRoutingConfig": {
"description": "A routing configuration attached to a network resource. The message\nincludes the list of routers associated with the network, and a flag\nindicating the type of routing behavior to enforce network-wide.",
"id": "NetworkRoutingConfig",
"properties": {
"bgpAlwaysCompareMed": {
"description": "Enable comparison of Multi-Exit Discriminators (MED) across routes with\ndifferent neighbor ASNs when using the STANDARD BGP best path selection\nalgorithm.",
"type": "boolean"
},
"bgpBestPathSelectionMode": {
"description": "The BGP best path selection algorithm to be employed within this network\nfor dynamic routes learned by Cloud Routers. Can be LEGACY\n(default) or STANDARD.",
"enum": [
"LEGACY",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"bgpInterRegionCost": {
"description": "Allows to define a preferred approach for handling inter-region cost in\nthe selection process when using the STANDARD BGP best path\nselection algorithm. Can be DEFAULT orADD_COST_TO_MED.",
"enum": [
"ADD_COST_TO_MED",
"DEFAULT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"effectiveBgpAlwaysCompareMed": {
"description": "Output only. [Output Only] Effective value of the bgp_always_compare_med\nfield.",
"readOnly": true,
"type": "boolean"
},
"effectiveBgpInterRegionCost": {
"description": "Output only. [Output Only] Effective value of the bgp_inter_region_cost\nfield.",
"enum": [
"ADD_COST_TO_MED",
"DEFAULT"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
},
"routingMode": {
"description": "The network-wide routing mode to use. If set to REGIONAL,\nthis network's Cloud Routers will only advertise routes with subnets\nof this network in the same region as the router. If set toGLOBAL, this network's Cloud Routers will advertise\nroutes 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. Useexchange_subnet_routes in network_peering\ninstead.\nIndicates whether full mesh connectivity is created and managed\nautomatically between peered networks. Currently this field should always\nbe true since Google Compute Engine will automatically create and manage\nsubnetwork routes between two networks when peering state isACTIVE.",
"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.\nIn order to specify route policies for peering using import and export\ncustom routes, you must specify all peering related parameters\n(name, peer network,exchange_subnet_routes) in the network_peering\nfield.\nThe corresponding fields in NetworksAddPeeringRequest will be\ndeprecated soon."
},
"peerNetwork": {
"description": "URL of the peer network.  It can be either full URL or partial URL. The\npeer network may belong to a different project. If the partial URL does not\ncontain project, it is assumed that the peer network is in the same project\nas the current network.",
"type": "string"
}
},
"type": "object"
},
"NetworksCancelRequestRemovePeeringRequest": {
"id": "NetworksCancelRequestRemovePeeringRequest",
"properties": {
"name": {
"description": "Name of the peering, which should conform to RFC1035.",
"type": "string"
}
},
"type": "object"
},
"NetworksGetEffectiveFirewallsResponse": {
"id": "NetworksGetEffectiveFirewallsResponse",
"properties": {
"firewallPolicys": {
"description": "[Output Only] Effective firewalls from firewall policy. It returns Global\nNetwork Firewall Policies and Hierarchical Firewall Policies. UseregionNetworkFirewallPolicies.getEffectiveFirewalls to get\nRegional Network Firewall Policies as well.",
"items": {
"$ref": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
},
"type": "array"
},
"firewalls": {
"description": "Effective firewalls on the network.",
"items": {
"$ref": "Firewall"
},
"type": "array"
}
},
"type": "object"
},
"NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
"id": "NetworksGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
"properties": {
"displayName": {
"deprecated": true,
"description": "Output only. [Output Only] Deprecated, please use short name instead. The display name\nof the firewall policy.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"packetMirroringRules": {
"description": "Output only. [Output Only] The packet mirroring rules that apply to the network.",
"items": {
"$ref": "FirewallPolicyRule"
},
"readOnly": true,
"type": "array"
},
"priority": {
"description": "Output only. [Output only] Priority of firewall policy association. Not applicable for\ntype=HIERARCHY.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"rules": {
"description": "[Output Only] The rules that apply to the network.",
"items": {
"$ref": "FirewallPolicyRule"
},
"type": "array"
},
"shortName": {
"description": "Output only. [Output Only] The short name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. [Output Only] The type of the firewall policy.",
"enum": [
"HIERARCHY",
"NETWORK",
"SYSTEM",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NetworksRemovePeeringRequest": {
"id": "NetworksRemovePeeringRequest",
"properties": {
"name": {
"description": "Name of the peering, which should conform to RFC1035.",
"type": "string"
}
},
"type": "object"
},
"NetworksRequestRemovePeeringRequest": {
"id": "NetworksRequestRemovePeeringRequest",
"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": "Represents a sole-tenant Node Group resource.\n\nA sole-tenant node is a physical server that is dedicated to\nhosting VM instances only for your specific project. Use sole-tenant nodes to\nkeep your instances physically separated from instances in other projects, or\nto group your instances together on the same host hardware. For more\ninformation, readSole-tenant nodes.",
"id": "NodeGroup",
"properties": {
"autoscalingPolicy": {
"$ref": "NodeGroupAutoscalingPolicy",
"description": "Specifies how autoscaling should behave."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#nodeGroup",
"description": "Output only. [Output Only] The type of the resource. Alwayscompute#nodeGroup for node group.",
"readOnly": true,
"type": "string"
},
"locationHint": {
"description": "An opaque location hint used to place the Node close to other\nresources.\nThis field is for use by internal tools that use the public API.\nThe location hint here on the NodeGroup overrides any location_hint\npresent in the NodeTemplate.",
"type": "string"
},
"maintenanceInterval": {
"description": "Specifies the frequency of planned maintenance events. The accepted values\nare: `AS_NEEDED` and `RECURRENT`.",
"enum": [
"AS_NEEDED",
"RECURRENT"
],
"enumDescriptions": [
"VMs are eligible to receive infrastructure and hypervisor updates as they\nbecome available.  This may result in more maintenance operations (live\nmigrations or terminations) for the VM than the PERIODIC andRECURRENT options.",
"VMs receive infrastructure and hypervisor updates on a periodic basis,\nminimizing the number of maintenance operations (live migrations or\nterminations) on an individual VM.  This may mean a VM will take longer\nto receive an update than if it was configured forAS_NEEDED.  Security updates will still be applied as soon\nas they are available. RECURRENT is used for GEN3 and Slice\nof Hardware VMs."
],
"type": "string"
},
"maintenancePolicy": {
"description": "Specifies how to handle instances when a node in the group undergoes\nmaintenance. Set to one of: DEFAULT,RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP.\nThe default value is DEFAULT. For more information, see\nMaintenance policies.",
"enum": [
"DEFAULT",
"MAINTENANCE_POLICY_UNSPECIFIED",
"MIGRATE_WITHIN_NODE_GROUP",
"RESTART_IN_PLACE"
],
"enumDescriptions": [
"Allow the node and corresponding instances to retain default\nmaintenance behavior.",
"",
"When maintenance must be done on a node, the instances on that node will\nbe moved to other nodes in the group.\nInstances with onHostMaintenance = MIGRATE will live migrate to their\ndestinations while instances with onHostMaintenance = TERMINATE will\nterminate and then restart on their destination nodes if\nautomaticRestart = true.",
"Instances in this group will restart on the same node when maintenance\nhas completed. Instances must have onHostMaintenance = TERMINATE, and\nthey will only restart if automaticRestart = true."
],
"type": "string"
},
"maintenanceWindow": {
"$ref": "NodeGroupMaintenanceWindow"
},
"name": {
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"type": "string"
},
"nodeTemplate": {
"description": "URL of the node template to create the node group from.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"shareSettings": {
"$ref": "ShareSettings",
"description": "Share-settings for the node group"
},
"size": {
"description": "Output only. [Output Only] The total number of nodes in the node group.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"status": {
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] The name of the zone where the node group resides,\nsuch as us-central1-a.",
"readOnly": true,
"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. [Output Only] Type of resource.Alwayscompute#nodeGroupAggregatedList for aggregated lists of node\ngroups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. Must be set if\nautoscaling is enabled. Maximum value allowed is 100.",
"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. Set to one of: ON, OFF,\nor ONLY_SCALE_OUT. For more information, see \nAutoscaler modes.",
"enum": [
"MODE_UNSPECIFIED",
"OFF",
"ON",
"ONLY_SCALE_OUT"
],
"enumDescriptions": [
"",
"Autoscaling is disabled.",
"Autocaling is fully enabled.",
"Autoscaling will only scale out and will not remove nodes."
],
"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. [Output Only] Type of resource.Always compute#nodeGroupList\nfor lists of node groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NodeGroupMaintenanceWindow": {
"description": "Time window specified for daily maintenance operations. GCE's internal\nmaintenance will be performed within this window.",
"id": "NodeGroupMaintenanceWindow",
"properties": {
"maintenanceDuration": {
"$ref": "Duration",
"description": "Output only. [Output only] A predetermined duration for the window, automatically\nchosen to be the smallest possible in the given scenario.",
"readOnly": true
},
"startTime": {
"description": "Start time of the window. This must be in UTC format that resolves to one\nof 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For\nexample, both 13:00-5 and 08:00 are valid.",
"type": "string"
}
},
"type": "object"
},
"NodeGroupNode": {
"id": "NodeGroupNode",
"properties": {
"accelerators": {
"description": "Accelerators for this node.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"consumedResources": {
"$ref": "InstanceConsumptionInfo",
"description": "Output only. Node resources that are reserved by all instances.",
"readOnly": true
},
"cpuOvercommitType": {
"description": "CPU overcommit.",
"enum": [
"CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
"ENABLED",
"NONE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"disks": {
"description": "Local disk configurations.",
"items": {
"$ref": "LocalDisk"
},
"type": "array"
},
"instanceConsumptionData": {
"description": "Output only. Instance data that shows consumed resources on the node.",
"items": {
"$ref": "InstanceConsumptionData"
},
"readOnly": true,
"type": "array"
},
"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"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"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"
},
"totalResources": {
"$ref": "InstanceConsumptionInfo",
"description": "Output only. Total amount of available resources on the node.",
"readOnly": true
},
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"description": "Output only. [Output Only] The information about an upcoming maintenance event.",
"readOnly": true
}
},
"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. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of Node resources.",
"items": {
"$ref": "NodeGroupNode"
},
"type": "array"
},
"kind": {
"default": "compute#nodeGroupsListNodes",
"description": "Output only. [Output Only] The resource type, which is alwayscompute.nodeGroupsListNodes for the list of nodes in the\nspecified node group.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"NodeGroupsPerformMaintenanceRequest": {
"id": "NodeGroupsPerformMaintenanceRequest",
"properties": {
"nodes": {
"description": "[Required] List of nodes affected by the call.",
"items": {
"type": "string"
},
"type": "array"
},
"startTime": {
"description": "The start time of the schedule. The timestamp is an RFC3339 string.",
"type": "string"
}
},
"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\nlist is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nnode group.",
"type": "string"
}
},
"type": "object"
},
"NodeGroupsSimulateMaintenanceEventRequest": {
"id": "NodeGroupsSimulateMaintenanceEventRequest",
"properties": {
"nodes": {
"description": "Names of the nodes to go under maintenance simulation.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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\nmore information, readCreating node groups\nand instances.",
"id": "NodeTemplate",
"properties": {
"accelerators": {
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"cpuOvercommitType": {
"description": "CPU overcommit.",
"enum": [
"CPU_OVERCOMMIT_TYPE_UNSPECIFIED",
"ENABLED",
"NONE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"disks": {
"items": {
"$ref": "LocalDisk"
},
"type": "array"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#nodeTemplate",
"description": "Output only. [Output Only] The type of the resource. Alwayscompute#nodeTemplate for node templates.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which\ncannot 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": "Do not use. Instead, use the node_type property."
},
"region": {
"description": "Output only. [Output Only] The name of the region where the node template resides,\nsuch as us-central1.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"serverBinding": {
"$ref": "ServerBinding",
"description": "Sets the binding properties for the physical server. Valid values include:\n   \n   - *[Default]* RESTART_NODE_ON_ANY_SERVER:\n   Restarts VMs on any available\n   physical server\n   - RESTART_NODE_ON_MINIMAL_SERVER: Restarts VMs on the same\n   physical server whenever possible\n\n\n\nSee Sole-tenant\nnode options for more information."
},
"status": {
"description": "Output only. [Output Only] The status of the node template. One of the following values:CREATING, READY, and DELETING.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"Resources are being allocated.",
"The node template is currently being deleted.",
"Invalid status.",
"The node template is ready."
],
"readOnly": true,
"type": "string"
},
"statusMessage": {
"description": "Output only. [Output Only] An optional, human-readable explanation of the status.",
"readOnly": true,
"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. [Output Only] Type of resource.Alwayscompute#nodeTemplateAggregatedList for aggregated lists of\nnode templates.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource.Always compute#nodeTemplateList\nfor lists of node templates.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nlist is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nthe total amount of cores and memory for that node. Currently, the only\navailable node type is n1-node-96-624 node type that has 96\nvCPUs and 624 GB of memory, available in multiple zones. For more information\nreadNode types.",
"id": "NodeType",
"properties": {
"cpuPlatform": {
"description": "[Output Only] The CPU platform used by this node type.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext 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\ntype.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#nodeType",
"description": "Output only. [Output Only] The type of the resource. Alwayscompute#nodeType for node types.",
"readOnly": true,
"type": "string"
},
"localSsdGb": {
"description": "[Output Only] Local SSD available to the node type, defined in GB.",
"format": "int32",
"type": "integer"
},
"maxVms": {
"description": "Output only. [Output Only] Maximum number of VMs that can be created for this node type.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"memoryMb": {
"description": "[Output Only] The amount of physical memory available to the node type,\ndefined 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. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] The name of the zone where the node type resides,\nsuch as us-central1-a.",
"readOnly": true,
"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. [Output Only] Type of resource.Alwayscompute#nodeTypeAggregatedList for aggregated lists of node\ntypes.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource.Always compute#nodeTypeList for\nlists of node types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nlist is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NotificationEndpoint": {
"description": "Represents a notification endpoint.\n\nA notification endpoint resource defines an endpoint to receive notifications\nwhen there are status changes detected by the associated health check\nservice.\n\nFor more information, see\nHealth checks overview.",
"id": "NotificationEndpoint",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"grpcSettings": {
"$ref": "NotificationEndpointGrpcSettings",
"description": "Settings of the gRPC notification endpoint including the endpoint URL and\nthe retry duration."
},
"id": {
"description": "Output only. [Output Only] A unique identifier for this resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#notificationEndpoint",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the notification endpoint resides.\nThis field applies only to the regional resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"NotificationEndpointAggregatedList": {
"description": "Contains a list of NotificationEndpointsScopedList.",
"id": "NotificationEndpointAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "NotificationEndpointsScopedList",
"description": "Name of the scope containing this set of NotificationEndpoints."
},
"description": "A list of NotificationEndpointsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#notificationEndpointAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NotificationEndpointGrpcSettings": {
"description": "Represents a gRPC setting that describes one gRPC notification endpoint and\nthe retry duration attempting to send notification to this endpoint.",
"id": "NotificationEndpointGrpcSettings",
"properties": {
"authority": {
"description": "Optional. If specified, this field is used to set the authority header by\nthe sender of notifications. See\nhttps://tools.ietf.org/html/rfc7540#section-8.1.2.3",
"type": "string"
},
"endpoint": {
"description": "Endpoint to which gRPC notifications are sent. This must be a valid\ngRPCLB DNS name.",
"type": "string"
},
"payloadName": {
"description": "Optional. If specified, this field is used to populate the \"name\" field\nin gRPC requests.",
"type": "string"
},
"resendInterval": {
"$ref": "Duration",
"description": "Optional. This field is used to configure how often to send a full update\nof all non-healthy backends. If unspecified, full updates are not sent.\nIf specified, must be in the range between 600 seconds to 3600 seconds.\nNanos are disallowed. Can only be set for regional notification\nendpoints."
},
"retryDurationSec": {
"description": "How much time (in seconds) is spent attempting notification retries\nuntil a successful response is received. Default is 30s. Limit is 20m\n(1200s). Must be a positive number.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"NotificationEndpointList": {
"id": "NotificationEndpointList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of NotificationEndpoint resources.",
"items": {
"$ref": "NotificationEndpoint"
},
"type": "array"
},
"kind": {
"default": "compute#notificationEndpointList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#notificationEndpoint for notification endpoints.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"NotificationEndpointsScopedList": {
"id": "NotificationEndpointsScopedList",
"properties": {
"resources": {
"description": "A list of NotificationEndpoints contained in this scope.",
"items": {
"$ref": "NotificationEndpoint"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nnotification endpoints when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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/v1/globalOperations)\n* [Regional](/compute/docs/reference/rest/v1/regionOperations)\n* [Zonal](/compute/docs/reference/rest/v1/zoneOperations)\n\nYou can use an operation resource to manage asynchronous API requests.\nFor more information, readHandling\nAPI responses.\n\nOperations can be global, regional or zonal.\n   \n   - For global operations, use the `globalOperations`\n   resource. \n   - For regional operations, use the\n   `regionOperations` resource. \n   - For zonal operations, use\n   the `zoneOperations` resource.\n\n\n\nFor more information, read\nGlobal, Regional, and Zonal Resources.\n\nNote that completed Operation resources have a limited \nretention period.",
"id": "Operation",
"properties": {
"clientOperationId": {
"description": "[Output Only] The value of `requestId` if you provided it in the request.\nNot 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\nset when the operation is created.",
"type": "string"
},
"endTime": {
"description": "[Output Only] The time that this operation was completed. This value is inRFC3339\ntext format.",
"type": "string"
},
"error": {
"description": "[Output Only] If errors are generated during processing of the operation,\nthis field will be populated.",
"properties": {
"errors": {
"description": "[Output Only] The array of errors encountered while processing this\noperation.",
"items": {
"properties": {
"code": {
"description": "[Output Only] The error type identifier for this error.",
"type": "string"
},
"errorDetails": {
"description": "[Output Only] An optional list of messages that contain the error\ndetails. There is a set of defined message types to use for providing\ndetails.The syntax depends on the error code. For example,\nQuotaExceededInfo will have details when the error code is\nQUOTA_EXCEEDED.",
"items": {
"properties": {
"errorInfo": {
"$ref": "ErrorInfo"
},
"help": {
"$ref": "Help"
},
"localizedMessage": {
"$ref": "LocalizedMessage"
},
"quotaInfo": {
"$ref": "QuotaExceededInfo"
}
},
"type": "object"
},
"type": "array"
},
"location": {
"description": "[Output Only] Indicates the field in the request that caused the error.\nThis property is optional.",
"type": "string"
},
"message": {
"description": "[Output Only] An optional, human-readable error message.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"getVersionOperationMetadata": {
"$ref": "GetVersionOperationMetadata"
},
"httpErrorMessage": {
"description": "[Output Only] If the operation fails, this field contains the HTTP error\nmessage that was returned, such as `NOT FOUND`.",
"type": "string"
},
"httpErrorStatusCode": {
"description": "[Output Only] If the operation fails, this field contains the HTTP error\nstatus code that was returned. For example, a `404` means the\nresource was not found.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the operation. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"insertTime": {
"description": "[Output Only] The time that this operation was requested.\nThis value is inRFC3339\ntext format.",
"type": "string"
},
"instancesBulkInsertOperationMetadata": {
"$ref": "InstancesBulkInsertOperationMetadata"
},
"kind": {
"default": "compute#operation",
"description": "Output only. [Output Only] Type of the resource. Always `compute#operation` for\nOperation resources.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "[Output Only] Name of the operation.",
"type": "string"
},
"operationGroupId": {
"description": "Output only. [Output Only] An ID that represents a group of operations, such as when a\ngroup of operations results from a `bulkInsert` API request.",
"readOnly": true,
"type": "string"
},
"operationType": {
"description": "[Output Only] The type of operation, such as `insert`,\n`update`, or `delete`, and so on.",
"type": "string"
},
"progress": {
"description": "[Output Only] An optional progress indicator that ranges from 0 to 100.\nThere is no requirement that this be linear or support any granularity of\noperations. This should not be used to guess when the operation will be\ncomplete. This number should monotonically increase as the operation\nprogresses.",
"format": "int32",
"type": "integer"
},
"region": {
"description": "[Output Only] The URL of the region where the operation resides. Only\napplicable when performing regional operations.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"setCommonInstanceMetadataOperationMetadata": {
"$ref": "SetCommonInstanceMetadataOperationMetadata",
"description": "Output only. [Output Only] If the operation is for projects.setCommonInstanceMetadata,\nthis field will contain information on all underlying zonal actions and\ntheir state.",
"readOnly": true
},
"startTime": {
"description": "[Output Only] The time that this operation was started by the server.\nThis value is inRFC3339\ntext format.",
"type": "string"
},
"status": {
"description": "[Output Only] The status of the operation, which can be one of the\nfollowing:\n`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\noperation.",
"type": "string"
},
"targetId": {
"description": "[Output Only] The unique target ID, which identifies a specific incarnation\nof the target resource.",
"format": "uint64",
"type": "string"
},
"targetLink": {
"description": "[Output Only] The URL of the resource that the operation modifies. For\noperations related to creating a snapshot, this points to the disk\nthat the snapshot was created from.",
"type": "string"
},
"user": {
"description": "[Output Only] User who requested the operation, for example:\n`user@example.com` or\n`alice_smith_identifier (global/workforcePools/example-com-us-employees)`.",
"type": "string"
},
"warnings": {
"description": "[Output Only] If warning messages are generated during processing of the\noperation, this field will be populated.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\napplicable 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\ndefined 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. [Output Only] Type of resource. Always `compute#operationAggregatedList`\nfor aggregated lists of operations.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger than\n`maxResults`, use the `nextPageToken` as a value for\nthe query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\ndefined 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. [Output Only] Type of resource. Always `compute#operations` for Operations\nresource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger than\n`maxResults`, use the `nextPageToken` as a value for\nthe query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"OrganizationSecurityPoliciesListAssociationsResponse": {
"id": "OrganizationSecurityPoliciesListAssociationsResponse",
"properties": {
"associations": {
"description": "A list of associations.",
"items": {
"$ref": "SecurityPolicyAssociation"
},
"type": "array"
},
"kind": {
"default": "compute#organizationSecurityPoliciesListAssociationsResponse",
"description": "Output only. [Output Only] Type of securityPolicy associations. Alwayscompute#organizationSecurityPoliciesListAssociations for lists\nof securityPolicy associations.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"OutlierDetection": {
"description": "Settings controlling the eviction of unhealthy hosts from the load balancing\npool for the backend service.",
"id": "OutlierDetection",
"properties": {
"baseEjectionTime": {
"$ref": "Duration",
"description": "The base time that a backend endpoint is ejected for. Defaults to 30000ms\nor 30s.\n\nAfter a backend endpoint is returned back to the load balancing pool, it\ncan be ejected again in another ejection analysis. Thus, the total ejection\ntime is equal to the base ejection time multiplied by the number of times\nthe backend endpoint has been ejected. Defaults to 30000ms or 30s."
},
"consecutiveErrors": {
"description": "Number of consecutive errors before a backend endpoint is ejected from the\nload balancing pool. When the backend endpoint is accessed over HTTP, a 5xx\nreturn 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\nconnection errors that are mapped to one of those status codes) before a\nconsecutive gateway failure ejection occurs. Defaults to 3.",
"format": "int32",
"type": "integer"
},
"enforcingConsecutiveErrors": {
"description": "The percentage chance that a backend endpoint will be ejected when an\noutlier status is detected through consecutive 5xx. This setting can be\nused to disable ejection or to ramp it up slowly. Defaults to 0.",
"format": "int32",
"type": "integer"
},
"enforcingConsecutiveGatewayFailure": {
"description": "The percentage chance that a backend endpoint will be ejected when an\noutlier status is detected through consecutive gateway failures. This\nsetting can be used to disable ejection or to ramp it up slowly. Defaults\nto 100.",
"format": "int32",
"type": "integer"
},
"enforcingSuccessRate": {
"description": "The percentage chance that a backend endpoint will be ejected when an\noutlier status is detected through success rate statistics. This setting\ncan be used to disable ejection or to ramp it up slowly. Defaults to 100.\n\nNot supported when the backend service uses Serverless NEG.",
"format": "int32",
"type": "integer"
},
"interval": {
"$ref": "Duration",
"description": "Time interval between ejection analysis sweeps. This can result in both new\nejections and backend endpoints being returned to service. The interval is\nequal to the number of seconds as defined in\noutlierDetection.interval.seconds plus the number of nanoseconds as defined\nin outlierDetection.interval.nanos. Defaults to 1 second."
},
"maxEjectionPercent": {
"description": "Maximum percentage of backend endpoints in the load balancing pool for the\nbackend service that can be ejected if the ejection conditions are met.\nDefaults to 50%.",
"format": "int32",
"type": "integer"
},
"successRateMinimumHosts": {
"description": "The number of backend endpoints in the load balancing pool that must have\nenough request volume to detect success rate outliers. If the number of\nbackend endpoints is fewer than this setting, outlier detection via success\nrate statistics is not performed for any backend endpoint in the load\nbalancing pool. Defaults to 5.\n\nNot supported when the backend service uses Serverless NEG.",
"format": "int32",
"type": "integer"
},
"successRateRequestVolume": {
"description": "The minimum number of total requests that must be collected in one interval\n(as defined by the interval duration above) to include this backend\nendpoint in success rate based outlier detection. If the volume is lower\nthan this setting, outlier detection via success rate statistics is not\nperformed for that backend endpoint. Defaults to 100.\n\nNot supported when the backend service uses Serverless NEG.",
"format": "int32",
"type": "integer"
},
"successRateStdevFactor": {
"description": "This factor is used to determine the ejection threshold for success rate\noutlier ejection. The ejection threshold is the difference between the mean\nsuccess rate, and the product of this factor and the standard deviation of\nthe mean success rate: mean - (stdev * successRateStdevFactor). This factor\nis divided by a thousand to get a double. That is, if the desired factor\nis 1.9, the runtime value should be 1900. Defaults to 1900.\n\nNot supported when the backend service uses Serverless NEG.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"PacketIntervals": {
"description": "Next free: 7",
"id": "PacketIntervals",
"properties": {
"avgMs": {
"description": "Average observed inter-packet interval in milliseconds.",
"format": "int64",
"type": "string"
},
"duration": {
"description": "From how long ago in the past these intervals were observed.",
"enum": [
"DURATION_UNSPECIFIED",
"HOUR",
"MAX",
"MINUTE"
],
"enumDescriptions": [
"",
"",
"From BfdSession object creation time.",
""
],
"type": "string"
},
"maxMs": {
"description": "Maximum observed inter-packet interval in milliseconds.",
"format": "int64",
"type": "string"
},
"minMs": {
"description": "Minimum observed inter-packet interval in milliseconds.",
"format": "int64",
"type": "string"
},
"numIntervals": {
"description": "Number of inter-packet intervals from which these statistics were derived.",
"format": "int64",
"type": "string"
},
"type": {
"description": "The type of packets for which inter-packet intervals were computed.",
"enum": [
"LOOPBACK",
"RECEIVE",
"TRANSMIT",
"TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Only applies to Echo packets. This shows the intervals between sending\nand receiving the same packet.",
"Intervals between received packets.",
"Intervals between transmitted packets.",
""
],
"type": "string"
}
},
"type": "object"
},
"PacketMirroring": {
"description": "Represents a Packet Mirroring resource.\n\nPacket Mirroring clones the traffic of specified instances in your Virtual\nPrivate Cloud (VPC) network and forwards it to a collector destination,\nsuch as an instance group of an internal TCP/UDP load balancer, for analysis\nor examination.\nFor more information about setting up Packet Mirroring, seeUsing Packet Mirroring.",
"id": "PacketMirroring",
"properties": {
"collectorIlb": {
"$ref": "PacketMirroringForwardingRuleInfo",
"description": "The Forwarding Rule resource of typeloadBalancingScheme=INTERNAL that will be used as collector\nfor mirrored traffic.\nThe specified forwarding rule must have isMirroringCollector\nset to true."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"enable": {
"description": "Indicates whether or not this packet mirroring takes effect.\nIf set to FALSE, this packet mirroring policy will not be enforced on the\nnetwork.\n\nThe default is TRUE.",
"enum": [
"FALSE",
"TRUE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"filter": {
"$ref": "PacketMirroringFilter",
"description": "Filter for mirrored traffic. If unspecified, all IPv4 traffic is mirrored."
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#packetMirroring",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#packetMirroring for packet mirrorings.",
"readOnly": true,
"type": "string"
},
"mirroredResources": {
"$ref": "PacketMirroringMirroredResourceInfo",
"description": "PacketMirroring mirroredResourceInfos.\nMirroredResourceInfo specifies a set of mirrored VM instances, subnetworks\nand/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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe 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\nmirrored. All mirrored VMs should have a NIC in the given network.\nAll mirrored subnetworks should belong to the given network."
},
"priority": {
"description": "The priority of applying this configuration. Priority is used to break ties\nin cases where there is more than one matching rule. In the case of two\nrules that apply for a given Instance, the one with the lowest-numbered\npriority 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. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nIf no protocols are specified, all traffic that matches the specified\nCIDR ranges is mirrored.\nIf neither cidrRanges nor IPProtocols is specified, all IPv4 traffic is\nmirrored.",
"items": {
"type": "string"
},
"type": "array"
},
"cidrRanges": {
"description": "One or more IPv4 or IPv6 CIDR ranges that apply as filters on the source\n(ingress) or destination (egress) IP in the IP header. If no ranges are\nspecified, all IPv4 traffic that matches the specified IPProtocols is\nmirrored. If neither cidrRanges nor IPProtocols is specified, all IPv4\ntraffic is mirrored. To mirror all IPv4 and IPv6 traffic, use\n\"0.0.0.0/0,::/0\".",
"items": {
"type": "string"
},
"type": "array"
},
"direction": {
"description": "Direction of traffic to mirror, either INGRESS, EGRESS, or BOTH.\nThe default is BOTH.",
"enum": [
"BOTH",
"EGRESS",
"INGRESS"
],
"enumDescriptions": [
"Default, both directions are mirrored.",
"Only egress traffic is mirrored.",
"Only ingress traffic is mirrored."
],
"type": "string"
}
},
"type": "object"
},
"PacketMirroringForwardingRuleInfo": {
"id": "PacketMirroringForwardingRuleInfo",
"properties": {
"canonicalUrl": {
"description": "Output only. [Output Only] Unique identifier for the forwarding rule; defined by the\nserver.",
"readOnly": true,
"type": "string"
},
"url": {
"description": "Resource URL to the forwarding rule representing the ILB\nconfigured 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. [Output Only] Type of resource. Always compute#packetMirroring\nfor packetMirrorings.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nThey must live in zones contained in the same region as this\npacketMirroring.\n\nNote that this config will apply only to those network interfaces of the\nInstances 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\nmirrored. 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\nmore of these tags will be mirrored.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"PacketMirroringMirroredResourceInfoInstanceInfo": {
"id": "PacketMirroringMirroredResourceInfoInstanceInfo",
"properties": {
"canonicalUrl": {
"description": "Output only. [Output Only] Unique identifier for the instance; defined by the\nserver.",
"readOnly": true,
"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. [Output Only] Unique identifier for the subnetwork; defined by the\nserver.",
"readOnly": true,
"type": "string"
},
"url": {
"description": "Resource URL to the subnetwork for which\ntraffic from/to all VM instances will be mirrored.",
"type": "string"
}
},
"type": "object"
},
"PacketMirroringNetworkInfo": {
"id": "PacketMirroringNetworkInfo",
"properties": {
"canonicalUrl": {
"description": "Output only. [Output Only] Unique identifier for the network; defined by the server.",
"readOnly": true,
"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\nlist is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nfrom the longest-matched rule will serve the URL. If no rule was matched, the\ndefault service is used.",
"id": "PathMatcher",
"properties": {
"defaultCustomErrorResponsePolicy": {
"$ref": "CustomErrorResponsePolicy",
"description": "defaultCustomErrorResponsePolicy specifies how the Load\nBalancer returns error responses when BackendServiceorBackendBucket responds with an error. \n\nThis policy takes\neffect at the PathMatcher level and applies only when no\npolicy has been defined for the error code at lower levels likeRouteRule and PathRule within thisPathMatcher. If an error code does not have a policy defined\nin defaultCustomErrorResponsePolicy, then a policy defined for\nthe error code in UrlMap.defaultCustomErrorResponsePolicy\ntakes effect. \n\nFor example, consider a UrlMap with the following\nconfiguration:\n   \n   \n     - UrlMap.defaultCustomErrorResponsePolicy is configured\n     with policies for 5xx and 4xx errors\n     - A RouteRule for /coming_soon/ is configured for the\n     error code 404.\n\nIf the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy\ntakes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,\nthe policy in RouteRule.customErrorResponsePolicy takes\neffect. If any of the requests in this example encounter a 500\nerror code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect. \n\nWhen\nused in conjunction withpathMatcher.defaultRouteAction.retryPolicy, retries take\nprecedence. Only once all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting\na retry, if load balancer is successful in reaching the\nservice, the defaultCustomErrorResponsePolicy is ignored and\nthe response from the service is returned to the client.\n\ndefaultCustomErrorResponsePolicy is supported only for\nglobal external Application Load Balancers."
},
"defaultRouteAction": {
"$ref": "HttpRouteAction",
"description": "defaultRouteAction takes effect when none of the \npathRules or routeRules match. The load balancer\nperforms advanced routing actions, such as URL rewrites and\nheader transformations, before forwarding the request to the\nselected backend.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\nURL maps for classic Application Load Balancers only support\nthe urlRewrite action within a path matcher'sdefaultRouteAction."
},
"defaultService": {
"description": "The full or partial URL to the BackendService resource. This\nURL is used if none of the pathRules orrouteRules defined by this PathMatcher are\nmatched. For example, the\nfollowing are all valid URLs to a BackendService resource:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/global/backendServices/backendService\n     - compute/v1/projects/project/global/backendServices/backendService\n     - global/backendServices/backendService\n\n\nIf defaultRouteAction is also specified, advanced\nrouting actions, such as URL rewrites, take effect before sending the\nrequest to the backend.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\nAuthorization requires one or more of the following Google IAM permissions on the\nspecified resource default_service: \n   \n   \n      - compute.backendBuckets.use\n      - compute.backendServices.use",
"type": "string"
},
"defaultUrlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When none of the specified pathRules orrouteRules match, the request is redirected to a URL specified\nby defaultUrlRedirect.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\nNot supported when the URL map is bound to a target gRPC proxy."
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect\nfor the selected backend service.\n\nHeaderAction specified here are applied after the matchingHttpRouteRule HeaderAction and before theHeaderAction in the UrlMap\n\nHeaderAction is not supported for load balancers\nthat have\ntheir loadBalancingScheme set to EXTERNAL.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true."
},
"name": {
"description": "The name to which this PathMatcher is referred by theHostRule.",
"type": "string"
},
"pathRules": {
"description": "The list of path rules. Use this list instead of routeRules\nwhen routing based on simple path matching is all that's required. A path\nrule can only include a wildcard character (*) after a\nforward slash character (\"/\").\n\nThe order by which path rules are specified does not matter.\nMatches are always done on the longest-path-first basis.\n\nFor example: a pathRule with a path /a/b/c/* will match\nbefore /a/b/* irrespective of the order in which those paths appear in this\nlist.\n\nWithin a given pathMatcher, only one ofpathRules or routeRules must be set.",
"items": {
"$ref": "PathRule"
},
"type": "array"
},
"routeRules": {
"description": "The list of HTTP route rules. Use this list instead ofpathRules when advanced route matching and routing actions are\ndesired. routeRules are evaluated in order of priority, from\nthe lowest to highest number.\n\nWithin a given pathMatcher, you can set only one ofpathRules or routeRules.",
"items": {
"$ref": "HttpRouteRule"
},
"type": "array"
}
},
"type": "object"
},
"PathRule": {
"description": "A path-matching rule for a URL. If matched, will use the specifiedBackendService to handle the traffic arriving at this URL.",
"id": "PathRule",
"properties": {
"customErrorResponsePolicy": {
"$ref": "CustomErrorResponsePolicy",
"description": "customErrorResponsePolicy specifies how the Load\nBalancer returns error responses when BackendServiceorBackendBucket responds with an error. \n\nIf a policy for an\nerror code is not configured for the PathRule, a policy for\nthe error code configured inpathMatcher.defaultCustomErrorResponsePolicy is applied. If\none is not specified inpathMatcher.defaultCustomErrorResponsePolicy, the policy\nconfigured in UrlMap.defaultCustomErrorResponsePolicy takes\neffect. \n\nFor example, consider a UrlMap with the following configuration:\n   \n   \n     - UrlMap.defaultCustomErrorResponsePolicy are configured\n     with policies for 5xx and 4xx errors\n     - A PathRule for /coming_soon/ is configured for the error\n     code 404.\n\nIf the request is for www.myotherdomain.com and a404 is encountered, the policy underUrlMap.defaultCustomErrorResponsePolicy takes effect. If a404 response is encountered for the requestwww.example.com/current_events/, the pathMatcher's policy\ntakes effect. If however, the request forwww.example.com/coming_soon/ encounters a 404,\nthe policy in PathRule.customErrorResponsePolicy takes\neffect. If any of the requests in this example encounter a 500\nerror code, the policy atUrlMap.defaultCustomErrorResponsePolicy takes effect.\n\ncustomErrorResponsePolicy is supported only for\nglobal external Application Load Balancers."
},
"paths": {
"description": "The list of path patterns to match. Each must start with /\nand the only place a * is allowed is at the end following\na /.  The string fed to the path matcher does not include\nany text after the first ? or #, and\nthose chars are not allowed here.",
"items": {
"type": "string"
},
"type": "array"
},
"routeAction": {
"$ref": "HttpRouteAction",
"description": "In response to a matching path, the load balancer\nperforms advanced routing actions, such as URL rewrites and header\ntransformations, before forwarding the request to the selected\nbackend.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.\n\n\nURL maps for classic Application Load Balancers only support\nthe urlRewrite action within a path rule'srouteAction."
},
"service": {
"description": "The full or partial URL of the backend service resource to which traffic\nis directed if this rule is matched. If routeAction is\nalso specified, advanced routing actions, such as URL rewrites,\ntake effect before sending the request to the backend.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.",
"type": "string"
},
"urlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When a path pattern is matched, the request is redirected to a URL\nspecified by urlRedirect.\n\n\nOnly one of urlRedirect, service orrouteAction.weightedBackendService can be set.\n\n\nNot supported when the URL map is bound to a target gRPC proxy."
}
},
"type": "object"
},
"PerInstanceConfig": {
"id": "PerInstanceConfig",
"properties": {
"fingerprint": {
"description": "Fingerprint of this per-instance config. This field can be used in\noptimistic locking. It is ignored when inserting a per-instance\nconfig. An up-to-date fingerprint must be provided in order to update an\nexisting per-instance configuration or the field needs to be unset.",
"format": "byte",
"type": "string"
},
"name": {
"description": "The name of a per-instance configuration and its corresponding instance.\nServes as a merge key during UpdatePerInstanceConfigs\noperations, that is, if a per-instance configuration with the same name\nexists then it will be updated, otherwise a new one will be created for the\nVM instance with the same name. An attempt to create a per-instance\nconfiguration for a VM instance that either doesn't exist or is not part\nof the group will result in an error.",
"type": "string"
},
"preservedState": {
"$ref": "PreservedState",
"description": "The intended preserved state for the given instance. Does not contain\npreserved state generated from a stateful policy."
},
"status": {
"description": "The status of applying this per-instance configuration on the corresponding\nmanaged instance.",
"enum": [
"APPLYING",
"DELETING",
"EFFECTIVE",
"NONE",
"UNAPPLIED",
"UNAPPLIED_DELETION"
],
"enumDescriptions": [
"The per-instance configuration is being applied to the instance, but is\nnot yet effective, possibly waiting for the instance to, for example,REFRESH.",
"The per-instance configuration deletion is being applied on the instance,\npossibly waiting for the instance to, for example, REFRESH.",
"The per-instance configuration is effective on the instance, meaning that\nall disks, ips and metadata specified in this configuration are attached\nor set on the instance.",
"*[Default]* The default status, when no per-instance configuration\nexists.",
"The per-instance configuration is set on an instance but not been applied\nyet.",
"The per-instance configuration has been deleted, but the deletion is not\nyet applied."
],
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access\ncontrols for Google Cloud resources.\n\n\nA `Policy` is a collection of `bindings`. A `binding` binds one or more\n`members`, or principals, to a single `role`. Principals can be user\naccounts, service accounts, Google groups, and domains (such as G Suite). A\n`role` is a named list of permissions; each `role` can be an IAM predefined\nrole or a user-created custom role.\n\nFor some types of Google Cloud resources, a `binding` can also specify a\n`condition`, which is a logical expression that allows access to a resource\nonly if the expression evaluates to `true`. A condition can add constraints\nbased on attributes of the request, the resource, or both. To learn which\nresources support conditions in their IAM policies, see the\n[IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).\n\n**JSON example:**\n\n```\n    {\n      \"bindings\": [\n        {\n          \"role\": \"roles/resourcemanager.organizationAdmin\",\n          \"members\": [\n            \"user:mike@example.com\",\n            \"group:admins@example.com\",\n            \"domain:google.com\",\n            \"serviceAccount:my-project-id@appspot.gserviceaccount.com\"\n          ]\n        },\n        {\n          \"role\": \"roles/resourcemanager.organizationViewer\",\n          \"members\": [\n            \"user:eve@example.com\"\n          ],\n          \"condition\": {\n            \"title\": \"expirable access\",\n            \"description\": \"Does not grant access after Sep 2020\",\n            \"expression\": \"request.time < timestamp('2020-10-01T00:00:00.000Z')\",\n          }\n        }\n      ],\n      \"etag\": \"BwWWja0YfJA=\",\n      \"version\": 3\n    }\n```\n\n**YAML example:**\n\n```\n    bindings:\n    - members:\n      - user:mike@example.com\n      - group:admins@example.com\n      - domain:google.com\n      - serviceAccount:my-project-id@appspot.gserviceaccount.com\n      role: roles/resourcemanager.organizationAdmin\n    - members:\n      - user:eve@example.com\n      role: roles/resourcemanager.organizationViewer\n      condition:\n        title: expirable access\n        description: Does not grant access after Sep 2020\n        expression: request.time < timestamp('2020-10-01T00:00:00.000Z')\n    etag: BwWWja0YfJA=\n    version: 3\n```\n\nFor a description of IAM and its features, see the\n[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`, or principals, with a `role`. Optionally,\nmay specify a `condition` that determines how and when the `bindings` are\napplied. Each of the `bindings` must contain at least one principal.\n\nThe `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250\nof these principals can be Google groups. Each occurrence of a principal\ncounts towards these limits. For example, if the `bindings` grant 50\ndifferent roles to `user:alice@example.com`, and not to any other\nprincipal, then you can add another 1,450 principals to the `bindings` in\nthe `Policy`.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure 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\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy.\n\nValid values are `0`, `1`, and `3`. Requests that specify an invalid value\nare rejected.\n\nAny operation that affects conditional role bindings must specify version\n`3`. This requirement applies to the following operations:\n\n* Getting a policy that includes a conditional role binding\n* Adding a conditional role binding to a policy\n* Changing a conditional role binding in a policy\n* Removing any role binding, with or without a condition, from a policy\n  that includes conditions\n\n**Important:** If you use IAM Conditions, you must include the `etag` field\nwhenever you call `setIamPolicy`. If you omit this field, then IAM allows\nyou to overwrite a version `3` policy with a version `1` policy, and all of\nthe conditions in the version `3` policy are lost.\n\nIf a policy does not include any conditions, operations on that policy may\nspecify any valid version or leave the field unset.\n\nTo learn which resources support conditions in their IAM policies, see the\n[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"
},
"PreservedState": {
"description": "Preserved state for a given instance.",
"id": "PreservedState",
"properties": {
"disks": {
"additionalProperties": {
"$ref": "PreservedStatePreservedDisk"
},
"description": "Preserved disks defined for this instance.\nThis map is keyed with the device names of the disks.",
"type": "object"
},
"externalIPs": {
"additionalProperties": {
"$ref": "PreservedStatePreservedNetworkIp"
},
"description": "Preserved external IPs defined for this instance.\nThis map is keyed with the name of the network interface.",
"type": "object"
},
"internalIPs": {
"additionalProperties": {
"$ref": "PreservedStatePreservedNetworkIp"
},
"description": "Preserved internal IPs defined for this instance.\nThis map is keyed with the name of the network interface.",
"type": "object"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Preserved metadata defined for this instance.",
"type": "object"
}
},
"type": "object"
},
"PreservedStatePreservedDisk": {
"id": "PreservedStatePreservedDisk",
"properties": {
"autoDelete": {
"description": "These stateful disks will never be deleted during autohealing,\nupdate, instance recreate operations. This flag is used to configure\nif the disk should be deleted after it is no longer used by the group,\ne.g. when the given instance or the whole MIG is deleted.\nNote: disks attached in READ_ONLY mode cannot be\nauto-deleted.",
"enum": [
"NEVER",
"ON_PERMANENT_INSTANCE_DELETION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"mode": {
"description": "The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the\ndisk in READ_WRITE mode.",
"enum": [
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"Attaches this disk in read-only mode. Multiple VM instances can use\na disk in READ_ONLY mode at a time.",
"*[Default]* Attaches this disk in READ_WRITE mode. Only\none VM instance at a time can be attached to a disk inREAD_WRITE mode."
],
"type": "string"
},
"source": {
"description": "The URL of the disk resource that is stateful and should be attached\nto the VM instance.",
"type": "string"
}
},
"type": "object"
},
"PreservedStatePreservedNetworkIp": {
"id": "PreservedStatePreservedNetworkIp",
"properties": {
"autoDelete": {
"description": "These stateful IPs will never be released during autohealing,\nupdate or VM instance recreate operations.\nThis flag is used to configure if the IP reservation should be deleted\nafter it is no longer used by the group, e.g. when the given instance\nor the whole group is deleted.",
"enum": [
"NEVER",
"ON_PERMANENT_INSTANCE_DELETION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"ipAddress": {
"$ref": "PreservedStatePreservedNetworkIpIpAddress",
"description": "Ip address representation"
}
},
"type": "object"
},
"PreservedStatePreservedNetworkIpIpAddress": {
"id": "PreservedStatePreservedNetworkIpIpAddress",
"properties": {
"address": {
"description": "The URL of the reservation for this IP address.",
"type": "string"
},
"literal": {
"description": "An IPv4 internal network address to assign to the instance for this\nnetwork interface.",
"type": "string"
}
},
"type": "object"
},
"PreviewFeature": {
"description": "Represents a single Google Compute Engine preview feature.",
"id": "PreviewFeature",
"properties": {
"activationStatus": {
"description": "Specifies whether the feature is enabled or disabled.",
"enum": [
"ACTIVATION_STATE_UNSPECIFIED",
"DISABLED",
"ENABLED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. [Output Only] Description of the feature.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#previewFeature",
"description": "Output only. [Output only] The type of the feature. Always \"compute#previewFeature\" for\npreview features.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the feature.",
"type": "string"
},
"rolloutOperation": {
"$ref": "PreviewFeatureRolloutOperation",
"description": "Rollout operation of the feature."
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "PreviewFeatureStatus",
"description": "Output only. [Output only] Status of the feature.",
"readOnly": true
}
},
"type": "object"
},
"PreviewFeatureList": {
"id": "PreviewFeatureList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of PreviewFeature resources.",
"items": {
"$ref": "PreviewFeature"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"PreviewFeatureRolloutOperation": {
"description": "Represents the rollout operation",
"id": "PreviewFeatureRolloutOperation",
"properties": {
"rolloutInput": {
"$ref": "PreviewFeatureRolloutOperationRolloutInput",
"description": "Input only. The input for the rollout operation."
}
},
"type": "object"
},
"PreviewFeatureRolloutOperationRolloutInput": {
"description": "Represents the input for the rollout operation.",
"id": "PreviewFeatureRolloutOperationRolloutInput",
"properties": {
"name": {
"description": "The name of the rollout plan\nEx.\norganizations//locations/global/rolloutPlans/\nEx.\nfolders//locations/global/rolloutPlans/\nEx.\nprojects//locations/global/rolloutPlans/.",
"type": "string"
},
"predefinedRolloutPlan": {
"description": "Predefined rollout plan.",
"enum": [
"ROLLOUT_PLAN_FAST_ROLLOUT",
"ROLLOUT_PLAN_TWO_DAY_ROLLOUT",
"ROLLOUT_PLAN_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"PreviewFeatureStatus": {
"description": "[Output Only] The status of the feature.",
"id": "PreviewFeatureStatus",
"properties": {
"description": {
"description": "Output only. [Output Only] The description of the feature.",
"readOnly": true,
"type": "string"
},
"helpLink": {
"description": "Output only. [Output Only] Link to the public documentation for the feature.",
"readOnly": true,
"type": "string"
},
"releaseStatus": {
"$ref": "PreviewFeatureStatusReleaseStatus"
}
},
"type": "object"
},
"PreviewFeatureStatusReleaseStatus": {
"description": "[Output Only] The release status of the feature.",
"id": "PreviewFeatureStatusReleaseStatus",
"properties": {
"stage": {
"description": "Output only. [Output Only] The stage of the feature.",
"enum": [
"DEPRECATED",
"GA",
"PREVIEW",
"STAGE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"updateDate": {
"$ref": "Date",
"description": "Output only. The last date when a feature transitioned between ReleaseStatuses.",
"readOnly": true
}
},
"type": "object"
},
"Project": {
"description": "Represents a Project resource.\n\nA project is used to organize resources in a Google Cloud Platform\nenvironment. For more information, read about the \nResource Hierarchy.",
"id": "Project",
"properties": {
"cloudArmorTier": {
"description": "Output only. [Output Only] The Cloud Armor tier for this project. It can be one of the\nfollowing values: CA_STANDARD,CA_ENTERPRISE_PAYGO.\n\nIf this field is not specified, it is assumed to beCA_STANDARD.",
"enum": [
"CA_ENTERPRISE_ANNUAL",
"CA_ENTERPRISE_PAYGO",
"CA_STANDARD"
],
"enumDescriptions": [
"Enterprise tier protection billed annually.",
"Enterprise tier protection billed monthly.",
"Standard protection."
],
"readOnly": true,
"type": "string"
},
"commonInstanceMetadata": {
"$ref": "Metadata",
"description": "Metadata key/value pairs available to all instances contained in this\nproject. See Custom\nmetadata for more information."
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"defaultNetworkTier": {
"description": "This signifies the default network tier used for configuring resources of\nthe project and can only take the following values:PREMIUM, STANDARD. Initially the default network\ntier is PREMIUM.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"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": "An optional list of 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\ndefined by the server. This is *not* the project ID, and is\njust a unique ID used by Compute Engine to identify resources.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#project",
"description": "Output only. [Output Only] Type of the resource. Always compute#project for\nprojects.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "The project ID. For example: my-example-project. Use the\nproject 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": "An optional naming prefix for daily usage reports and the Google Cloud\nStorage bucket where they are stored."
},
"vmDnsSetting": {
"description": "Output only. [Output Only] Default internal DNS setting used by VMs running in\nthis project.",
"enum": [
"GLOBAL_DEFAULT",
"UNSPECIFIED_VM_DNS_SETTING",
"ZONAL_DEFAULT",
"ZONAL_ONLY"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"xpnProjectStatus": {
"description": "[Output Only] The role this project has in a shared VPC configuration.\nCurrently, only projects with the host role, which is specified by the\nvalue HOST, 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. [Output Only] Type of resource. Alwayscompute#projectsGetXpnResources for lists of service resources\n(a.k.a service projects)",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"resources": {
"description": "Service resources (a.k.a service projects) attached to this project as\ntheir 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\nlist shared VPC host projects. If not specified, the organization will be\ninferred from the project.",
"type": "string"
}
},
"type": "object"
},
"ProjectsSetCloudArmorTierRequest": {
"id": "ProjectsSetCloudArmorTierRequest",
"properties": {
"cloudArmorTier": {
"description": "Managed protection tier to be set.",
"enum": [
"CA_ENTERPRISE_ANNUAL",
"CA_ENTERPRISE_PAYGO",
"CA_STANDARD"
],
"enumDescriptions": [
"Enterprise tier protection billed annually.",
"Enterprise tier protection billed monthly.",
"Standard protection."
],
"type": "string"
}
},
"type": "object"
},
"ProjectsSetDefaultNetworkTierRequest": {
"id": "ProjectsSetDefaultNetworkTierRequest",
"properties": {
"networkTier": {
"description": "Default network tier to be set.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"type": "string"
}
},
"type": "object"
},
"PublicAdvertisedPrefix": {
"description": "A public advertised prefix represents an aggregated IP prefix or netblock\nwhich customers bring to cloud. The IP prefix is a single unit of route\nadvertisement and is announced globally to the internet.",
"id": "PublicAdvertisedPrefix",
"properties": {
"byoipApiVersion": {
"description": "Output only. [Output Only] The version of BYOIP API.",
"enum": [
"V1",
"V2"
],
"enumDescriptions": [
"This public advertised prefix can be used to create both regional and\nglobal public delegated prefixes. It usually takes 4 weeks to create or\ndelete a public delegated prefix. The BGP status cannot be changed.",
"This public advertised prefix can only be used to create regional public\ndelegated prefixes. Public delegated prefix creation and deletion takes\nminutes and the BGP status can be modified."
],
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"dnsVerificationIp": {
"description": "The address to be used for reverse DNS verification.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a new PublicAdvertisedPrefix. An up-to-date\nfingerprint must be provided in order to update thePublicAdvertisedPrefix, otherwise the request will fail with\nerror 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a PublicAdvertisedPrefix.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"ipCidrRange": {
"description": "The address range, in CIDR format, represented by this public advertised\nprefix.",
"type": "string"
},
"ipv6AccessType": {
"description": "The internet access type for IPv6 Public Advertised Prefixes.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"Default IPv6 access type. The prefix will be announced to the internet.\nAll children Public Delegated Prefixes will have IPv6 access type as\nEXTERNAL.",
"The prefix will not be announced to the internet. Prefix will be used\nprivately within Cloud. All children Public Delegated Prefixes\nwill have IPv6 access type as INTERNAL."
],
"type": "string"
},
"kind": {
"default": "compute#publicAdvertisedPrefix",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.publicAdvertisedPrefixes.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"pdpScope": {
"description": "Specifies how child public delegated prefix will be scoped. It could\nbe one of following values:\n   \n   \n     - `REGIONAL`: The public delegated prefix is regional only. The\n     provisioning will take a few minutes.\n     - `GLOBAL`: The public delegated prefix is global only. The\n     provisioning will take ~4 weeks.\n     - `GLOBAL_AND_REGIONAL` [output only]: The public delegated prefixes is\n      BYOIP V1 legacy prefix. This is output only value and no longer\n      supported in BYOIP V2.",
"enum": [
"GLOBAL",
"GLOBAL_AND_REGIONAL",
"REGIONAL"
],
"enumDescriptions": [
"The public delegated prefix is global only. The provisioning will take ~4\nweeks.",
"The public delegated prefixes is BYOIP V1 legacy prefix. This is output\nonly value and no longer supported in BYOIP V2.",
"The public delegated prefix is regional only. The provisioning will take\na few minutes."
],
"type": "string"
},
"publicDelegatedPrefixs": {
"description": "Output only. [Output Only] The list of public delegated prefixes that exist for this\npublic advertised prefix.",
"items": {
"$ref": "PublicAdvertisedPrefixPublicDelegatedPrefix"
},
"readOnly": true,
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"sharedSecret": {
"description": "[Output Only] The shared secret to be used for reverse DNS verification.",
"type": "string"
},
"status": {
"description": "The status of the public advertised prefix. Possible values include:\n   \n   \n     - `INITIAL`: RPKI validation is complete.\n     - `PTR_CONFIGURED`: User has configured the PTR.\n     - `VALIDATED`: Reverse DNS lookup is successful.\n     - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed.\n     - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being\n     configured.\n     - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured.\n     - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed.",
"enum": [
"ANNOUNCED_TO_INTERNET",
"INITIAL",
"PREFIX_CONFIGURATION_COMPLETE",
"PREFIX_CONFIGURATION_IN_PROGRESS",
"PREFIX_REMOVAL_IN_PROGRESS",
"PTR_CONFIGURED",
"READY_TO_ANNOUNCE",
"REVERSE_DNS_LOOKUP_FAILED",
"VALIDATED"
],
"enumDescriptions": [
"The prefix is announced to Internet.",
"RPKI validation is complete.",
"The prefix is fully configured.",
"The prefix is being configured.",
"The prefix is being removed.",
"User has configured the PTR.",
"The prefix is currently withdrawn but ready to be announced.",
"Reverse DNS lookup failed.",
"Reverse DNS lookup is successful."
],
"type": "string"
}
},
"type": "object"
},
"PublicAdvertisedPrefixList": {
"id": "PublicAdvertisedPrefixList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of PublicAdvertisedPrefix resources.",
"items": {
"$ref": "PublicAdvertisedPrefix"
},
"type": "array"
},
"kind": {
"default": "compute#publicAdvertisedPrefixList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#publicAdvertisedPrefix for public advertised prefixes.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"PublicAdvertisedPrefixPublicDelegatedPrefix": {
"description": "Represents a CIDR range which can be used to assign addresses.",
"id": "PublicAdvertisedPrefixPublicDelegatedPrefix",
"properties": {
"ipRange": {
"description": "The IP address range of the public delegated prefix",
"type": "string"
},
"name": {
"description": "The name of the public delegated prefix",
"type": "string"
},
"project": {
"description": "The project number of the public delegated prefix",
"type": "string"
},
"region": {
"description": "The region of the public delegated prefix if it is regional. If absent,\nthe prefix is global.",
"type": "string"
},
"status": {
"description": "The status of the public delegated prefix. Possible values are:\n  INITIALIZING: The public delegated prefix is being initialized and\n    addresses cannot be created yet.\n  ANNOUNCED: The public delegated prefix is active.",
"type": "string"
}
},
"type": "object"
},
"PublicDelegatedPrefix": {
"description": "A PublicDelegatedPrefix resource represents an IP block within a\nPublicAdvertisedPrefix that is configured within a single cloud scope\n(global or region). IPs in the block can be allocated to resources within\nthat scope. Public delegated prefixes may be further broken up into\nsmaller IP blocks in the same scope as the parent block.",
"id": "PublicDelegatedPrefix",
"properties": {
"allocatablePrefixLength": {
"description": "The allocatable prefix length supported by this public delegated prefix.\nThis field is optional and cannot be set for prefixes in DELEGATION mode.\nIt cannot be set for IPv4 prefixes either, and it always defaults to 32.",
"format": "int32",
"type": "integer"
},
"byoipApiVersion": {
"description": "Output only. [Output Only] The version of BYOIP API.",
"enum": [
"V1",
"V2"
],
"enumDescriptions": [
"This public delegated prefix usually takes 4 weeks to delete, and the BGP\nstatus cannot be changed. Announce and Withdraw APIs can not be used on\nthis prefix.",
"This public delegated prefix takes minutes to delete. Announce and\nWithdraw APIs can be used on this prefix to change the BGP status."
],
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"enableEnhancedIpv4Allocation": {
"description": "Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations.\nApplicable for IPv4 PDPs only.",
"readOnly": true,
"type": "boolean"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a new PublicDelegatedPrefix. An up-to-date\nfingerprint must be provided in order to update thePublicDelegatedPrefix, otherwise the request will fail with\nerror 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a PublicDelegatedPrefix.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"ipCidrRange": {
"description": "The IP address range, in CIDR format, represented by this public\ndelegated prefix.",
"type": "string"
},
"ipv6AccessType": {
"description": "Output only. [Output Only] The internet access type for IPv6 Public Delegated Prefixes.\nInherited from parent prefix.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"The parent public advertised prefix will be announced to the internet.\nAll children public delegated prefixes will have IPv6 access type as\nEXTERNAL.",
"The parent public advertised prefix will not be announced to the\ninternet. Prefix will be used privately within Cloud. All children\npublic delegated prefixes will have IPv6 access type as INTERNAL."
],
"readOnly": true,
"type": "string"
},
"isLiveMigration": {
"description": "If true, the prefix will be live migrated.",
"type": "boolean"
},
"kind": {
"default": "compute#publicDelegatedPrefix",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefix for public delegated prefixes.",
"readOnly": true,
"type": "string"
},
"mode": {
"description": "The public delegated prefix mode for IPv6 only.",
"enum": [
"DELEGATION",
"EXTERNAL_IPV6_FORWARDING_RULE_CREATION",
"EXTERNAL_IPV6_SUBNETWORK_CREATION",
"INTERNAL_IPV6_SUBNETWORK_CREATION"
],
"enumDescriptions": [
"The public delegated prefix is used for further sub-delegation only. Such\nprefixes cannot set allocatablePrefixLength.",
"The public delegated prefix is used for creating forwarding rules only.\nSuch prefixes cannot set publicDelegatedSubPrefixes. Parent public\ndelegated prefix must have IPv6 access type as EXTERNAL.",
"The public delegated prefix is used for creating dual-mode subnetworks\nonly. Such prefixes cannot set publicDelegatedSubPrefixes. Parent public\ndelegated prefix must have IPv6 access type as EXTERNAL.",
"The public delegated prefix is used for creating dual stack or IPv6-only\nsubnetwork with internal access only. Such prefixes cannot set\npublicDelegatedSubPrefixes and allocatablePrefixLength. Parent public\ndelegated prefix must have IPv6 access type as INTERNAL."
],
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.publicDelegatedPrefixes.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"parentPrefix": {
"description": "The URL of parent prefix. Either PublicAdvertisedPrefix or\nPublicDelegatedPrefix.",
"type": "string"
},
"publicDelegatedSubPrefixs": {
"description": "The list of sub public delegated prefixes that exist for this public\ndelegated prefix.",
"items": {
"$ref": "PublicDelegatedPrefixPublicDelegatedSubPrefix"
},
"type": "array"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the public delegated prefix resides.\nThis field applies only to the region resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "[Output Only] The status of the public delegated prefix, which can be one\nof following values:\n   \n   \n     - `INITIALIZING` The public delegated prefix is being initialized and\n     addresses cannot be created yet.\n     - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration\n     prefix and is active.\n     - `ANNOUNCED` The public delegated prefix is announced and ready to\n     use.\n     - `DELETING` The public delegated prefix is being deprovsioned.\n     - `ACTIVE` The public delegated prefix is ready to use.",
"enum": [
"ACTIVE",
"ANNOUNCED",
"ANNOUNCED_TO_GOOGLE",
"ANNOUNCED_TO_INTERNET",
"DELETING",
"INITIALIZING",
"READY_TO_ANNOUNCE"
],
"enumDescriptions": [
"The public delegated prefix is ready to use.",
"The public delegated prefix is announced and ready to use.",
"The prefix is announced within Google network.",
"The prefix is announced to Internet and within Google.",
"The public delegated prefix is being deprovsioned.",
"The public delegated prefix is being initialized and addresses cannot be\ncreated yet.",
"The public delegated prefix is currently withdrawn but ready to be\nannounced."
],
"type": "string"
}
},
"type": "object"
},
"PublicDelegatedPrefixAggregatedList": {
"id": "PublicDelegatedPrefixAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "PublicDelegatedPrefixesScopedList",
"description": "[Output Only] Name of the scope containing this set of\nPublicDelegatedPrefixes."
},
"description": "A list of PublicDelegatedPrefixesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#publicDelegatedPrefixAggregatedList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefixAggregatedList for aggregated\nlists of public delegated prefixes.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"PublicDelegatedPrefixList": {
"id": "PublicDelegatedPrefixList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of PublicDelegatedPrefix resources.",
"items": {
"$ref": "PublicDelegatedPrefix"
},
"type": "array"
},
"kind": {
"default": "compute#publicDelegatedPrefixList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#publicDelegatedPrefixList for public delegated\nprefixes.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"PublicDelegatedPrefixPublicDelegatedSubPrefix": {
"description": "Represents a sub PublicDelegatedPrefix.",
"id": "PublicDelegatedPrefixPublicDelegatedSubPrefix",
"properties": {
"allocatablePrefixLength": {
"description": "The allocatable prefix length supported by this PublicDelegatedSubPrefix.",
"format": "int32",
"type": "integer"
},
"delegateeProject": {
"description": "Name of the project scoping this PublicDelegatedSubPrefix.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"enableEnhancedIpv4Allocation": {
"description": "Output only. [Output Only] Whether this PDP supports enhanced IPv4 allocations.\nApplicable for IPv4 PDPs only.",
"readOnly": true,
"type": "boolean"
},
"ipCidrRange": {
"description": "The IP address range, in CIDR format, represented by this sub public\ndelegated prefix.",
"type": "string"
},
"ipv6AccessType": {
"description": "Output only. [Output Only] The internet access type for IPv6 Public Delegated Sub\nPrefixes. Inherited from parent prefix.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"The parent public advertised prefix will be announced to the internet.\nAll children public delegated prefixes will have IPv6 access type as\nEXTERNAL.",
"The parent public advertised prefix will not be announced to the\ninternet. Prefix will be used privately within Cloud. All children\npublic delegated prefixes will have IPv6 access type as INTERNAL."
],
"readOnly": true,
"type": "string"
},
"isAddress": {
"description": "Whether the sub prefix is delegated to create Address resources in the\ndelegatee project.",
"type": "boolean"
},
"mode": {
"description": "The PublicDelegatedSubPrefix mode for IPv6 only.",
"enum": [
"DELEGATION",
"EXTERNAL_IPV6_FORWARDING_RULE_CREATION",
"EXTERNAL_IPV6_SUBNETWORK_CREATION",
"INTERNAL_IPV6_SUBNETWORK_CREATION"
],
"enumDescriptions": [
"The public delegated prefix is used for further sub-delegation only. Such\nprefixes cannot set allocatablePrefixLength.",
"The public delegated prefix is used for creating forwarding rules only.\nSuch prefixes cannot set publicDelegatedSubPrefixes. Parent public\ndelegated prefix must have IPv6 access type as EXTERNAL.",
"The public delegated prefix is used for creating dual-mode subnetworks\nonly. Such prefixes cannot set publicDelegatedSubPrefixes. Parent public\ndelegated prefix must have IPv6 access type as EXTERNAL.",
"The public delegated prefix is used for creating dual stack or IPv6-only\nsubnetwork with internal access only. Such prefixes cannot set\npublicDelegatedSubPrefixes and allocatablePrefixLength. Parent public\ndelegated prefix must have IPv6 access type as INTERNAL."
],
"type": "string"
},
"name": {
"description": "The name of the sub public delegated prefix.",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] The region of the sub public delegated prefix if it is\nregional. If absent, the sub prefix is global.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of the sub public delegated prefix.",
"enum": [
"ACTIVE",
"INACTIVE"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"PublicDelegatedPrefixesScopedList": {
"id": "PublicDelegatedPrefixesScopedList",
"properties": {
"publicDelegatedPrefixes": {
"description": "[Output Only] A list of PublicDelegatedPrefixes contained in this scope.",
"items": {
"$ref": "PublicDelegatedPrefix"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of\npublic delegated prefixes when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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": [
"A2_CPUS",
"AFFINITY_GROUPS",
"AUTOSCALERS",
"BACKEND_BUCKETS",
"BACKEND_SERVICES",
"C2D_CPUS",
"C2_CPUS",
"C3_CPUS",
"COMMITMENTS",
"COMMITTED_A2_CPUS",
"COMMITTED_C2D_CPUS",
"COMMITTED_C2_CPUS",
"COMMITTED_C3_CPUS",
"COMMITTED_CPUS",
"COMMITTED_E2_CPUS",
"COMMITTED_LICENSES",
"COMMITTED_LOCAL_SSD_TOTAL_GB",
"COMMITTED_M3_CPUS",
"COMMITTED_MEMORY_OPTIMIZED_CPUS",
"COMMITTED_N2A_CPUS",
"COMMITTED_N2D_CPUS",
"COMMITTED_N2_CPUS",
"COMMITTED_NVIDIA_A100_80GB_GPUS",
"COMMITTED_NVIDIA_A100_GPUS",
"COMMITTED_NVIDIA_H100_GPUS",
"COMMITTED_NVIDIA_K80_GPUS",
"COMMITTED_NVIDIA_L4_GPUS",
"COMMITTED_NVIDIA_P100_GPUS",
"COMMITTED_NVIDIA_P4_GPUS",
"COMMITTED_NVIDIA_T4_GPUS",
"COMMITTED_NVIDIA_V100_GPUS",
"COMMITTED_T2A_CPUS",
"COMMITTED_T2D_CPUS",
"COMMITTED_Z3_CPUS",
"CPUS",
"CPUS_ALL_REGIONS",
"DISKS_TOTAL_GB",
"E2_CPUS",
"EXTERNAL_MANAGED_FORWARDING_RULES",
"EXTERNAL_NETWORK_LB_FORWARDING_RULES",
"EXTERNAL_PROTOCOL_FORWARDING_RULES",
"EXTERNAL_VPN_GATEWAYS",
"FIREWALLS",
"FORWARDING_RULES",
"GLOBAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
"GLOBAL_EXTERNAL_MANAGED_FORWARDING_RULES",
"GLOBAL_EXTERNAL_PROXY_LB_BACKEND_SERVICES",
"GLOBAL_INTERNAL_ADDRESSES",
"GLOBAL_INTERNAL_MANAGED_BACKEND_SERVICES",
"GLOBAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES",
"GPUS_ALL_REGIONS",
"HDB_TOTAL_GB",
"HDB_TOTAL_IOPS",
"HDB_TOTAL_THROUGHPUT",
"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",
"INTERNAL_TRAFFIC_DIRECTOR_FORWARDING_RULES",
"IN_PLACE_SNAPSHOTS",
"IN_USE_ADDRESSES",
"IN_USE_BACKUP_SCHEDULES",
"IN_USE_SNAPSHOT_SCHEDULES",
"LOCAL_SSD_TOTAL_GB",
"M1_CPUS",
"M2_CPUS",
"M3_CPUS",
"MACHINE_IMAGES",
"N2A_CPUS",
"N2D_CPUS",
"N2_CPUS",
"NETWORKS",
"NETWORK_ATTACHMENTS",
"NETWORK_ENDPOINT_GROUPS",
"NETWORK_FIREWALL_POLICIES",
"NET_LB_SECURITY_POLICIES_PER_REGION",
"NET_LB_SECURITY_POLICY_RULES_PER_REGION",
"NET_LB_SECURITY_POLICY_RULE_ATTRIBUTES_PER_REGION",
"NODE_GROUPS",
"NODE_TEMPLATES",
"NVIDIA_A100_80GB_GPUS",
"NVIDIA_A100_GPUS",
"NVIDIA_K80_GPUS",
"NVIDIA_L4_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",
"PD_EXTREME_TOTAL_PROVISIONED_IOPS",
"PREEMPTIBLE_CPUS",
"PREEMPTIBLE_LOCAL_SSD_GB",
"PREEMPTIBLE_NVIDIA_A100_80GB_GPUS",
"PREEMPTIBLE_NVIDIA_A100_GPUS",
"PREEMPTIBLE_NVIDIA_H100_GPUS",
"PREEMPTIBLE_NVIDIA_K80_GPUS",
"PREEMPTIBLE_NVIDIA_L4_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",
"PREEMPTIBLE_TPU_LITE_DEVICE_V5",
"PREEMPTIBLE_TPU_LITE_PODSLICE_V5",
"PREEMPTIBLE_TPU_PODSLICE_V4",
"PSC_ILB_CONSUMER_FORWARDING_RULES_PER_PRODUCER_NETWORK",
"PSC_INTERNAL_LB_FORWARDING_RULES",
"PUBLIC_ADVERTISED_PREFIXES",
"PUBLIC_DELEGATED_PREFIXES",
"REGIONAL_AUTOSCALERS",
"REGIONAL_EXTERNAL_MANAGED_BACKEND_SERVICES",
"REGIONAL_EXTERNAL_NETWORK_LB_BACKEND_SERVICES",
"REGIONAL_INSTANCE_GROUP_MANAGERS",
"REGIONAL_INTERNAL_LB_BACKEND_SERVICES",
"REGIONAL_INTERNAL_MANAGED_BACKEND_SERVICES",
"REGIONAL_INTERNAL_TRAFFIC_DIRECTOR_BACKEND_SERVICES",
"RESERVATIONS",
"RESOURCE_POLICIES",
"ROUTERS",
"ROUTES",
"SECURITY_POLICIES",
"SECURITY_POLICIES_PER_REGION",
"SECURITY_POLICY_ADVANCED_RULES_PER_REGION",
"SECURITY_POLICY_CEVAL_RULES",
"SECURITY_POLICY_RULES",
"SECURITY_POLICY_RULES_PER_REGION",
"SERVICE_ATTACHMENTS",
"SNAPSHOTS",
"SSD_TOTAL_GB",
"SSL_CERTIFICATES",
"SSL_POLICIES",
"STATIC_ADDRESSES",
"STATIC_BYOIP_ADDRESSES",
"STATIC_EXTERNAL_IPV6_ADDRESS_RANGES",
"SUBNETWORKS",
"T2A_CPUS",
"T2D_CPUS",
"TARGET_HTTPS_PROXIES",
"TARGET_HTTP_PROXIES",
"TARGET_INSTANCES",
"TARGET_POOLS",
"TARGET_SSL_PROXIES",
"TARGET_TCP_PROXIES",
"TARGET_VPN_GATEWAYS",
"TPU_LITE_DEVICE_V5",
"TPU_LITE_PODSLICE_V5",
"TPU_PODSLICE_V4",
"URL_MAPS",
"VARIABLE_IPV6_PUBLIC_DELEGATED_PREFIXES",
"VPN_GATEWAYS",
"VPN_TUNNELS",
"XPN_SERVICE_PROJECTS"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"Guest CPUs",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"The total number of snapshots allowed for a single project.",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"owner": {
"description": "[Output Only] Owning resource. This is the resource on which this quota\nis applied.",
"type": "string"
},
"usage": {
"description": "[Output Only] Current usage of this metric.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"QuotaExceededInfo": {
"description": "Additional details for quota exceeded error for resource quota.",
"id": "QuotaExceededInfo",
"properties": {
"dimensions": {
"additionalProperties": {
"type": "string"
},
"description": "The map holding related quota dimensions.",
"type": "object"
},
"futureLimit": {
"description": "Future quota limit being rolled out. The limit's unit depends on the quota\n type or metric.",
"format": "double",
"type": "number"
},
"limit": {
"description": "Current effective quota limit. The limit's unit depends on the quota type\nor metric.",
"format": "double",
"type": "number"
},
"limitName": {
"description": "The name of the quota limit.",
"type": "string"
},
"metricName": {
"description": "The Compute Engine quota metric name.",
"type": "string"
},
"rolloutStatus": {
"description": "Rollout status of the future quota limit.",
"enum": [
"IN_PROGRESS",
"ROLLOUT_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"IN_PROGRESS - A rollout is in process which will change the limit value\nto future limit.",
"ROLLOUT_STATUS_UNSPECIFIED - Rollout status is not specified. The default\nvalue."
],
"type": "string"
}
},
"type": "object"
},
"Reference": {
"description": "Represents a reference to a resource.",
"id": "Reference",
"properties": {
"kind": {
"default": "compute#reference",
"description": "Output only. [Output Only] Type of the resource. Always compute#reference\nfor references.",
"readOnly": true,
"type": "string"
},
"referenceType": {
"description": "A description of the reference type with no implied semantics. Possible\nvalues include:\n   \n   \n    1. 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\ninformation, readRegions\nand Zones.",
"id": "Region",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#region",
"description": "Output only. [Output Only] Type of the resource. Always compute#region for\nregions.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "[Output Only] Name of the resource.",
"type": "string"
},
"quotaStatusWarning": {
"description": "Output only. [Output Only] Warning of fetching the `quotas` field for this region. This\nfield is populated only if fetching of the `quotas` field fails.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
},
"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 orDOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"supportsPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"zones": {
"description": "[Output Only] A list of zones available in this region, in the form of\nresource URLs.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionAddressesMoveRequest": {
"id": "RegionAddressesMoveRequest",
"properties": {
"description": {
"description": "An optional destination address description if intended to be different\nfrom the source.",
"type": "string"
},
"destinationAddress": {
"description": "The URL of the destination address to move to. This can be a full or\npartial URL. For example, the following are all valid URLs to a address:\n   \n   - https://www.googleapis.com/compute/v1/projects/project/regions/region/addresses/address \n   - projects/project/regions/region/addresses/address\n\n\nNote that destination project must be different from the source project. So/regions/region/addresses/address is not valid partial url.",
"type": "string"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Alwayscompute#regionDiskTypeList for region disk types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RegionDiskUpdateKmsKeyRequest": {
"id": "RegionDiskUpdateKmsKeyRequest",
"properties": {
"kmsKeyName": {
"description": "Optional. The new KMS key to replace the current one on the disk. If empty, the disk\nwill be re-encrypted using the primary version of the disk's current KMS\nkey.\n\nThe KMS key can be provided in the following formats:\n   \n   \n     - projects/project_id/locations/location/keyRings/key_ring/cryptoKeys/key\n\n\nWhere project is the project ID or\nproject number.",
"type": "string"
}
},
"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"
},
"RegionDisksStartAsyncReplicationRequest": {
"id": "RegionDisksStartAsyncReplicationRequest",
"properties": {
"asyncSecondaryDisk": {
"description": "The secondary disk to start asynchronous replication to.\nYou can provide this as a partial or full URL to the resource. For example,\nthe following are valid values:\n   \n   \n     - \n       https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk\n     \n     - \n       https://www.googleapis.com/compute/v1/projects/project/regions/region/disks/disk\n     \n     - \n       projects/project/zones/zone/disks/disk\n     \n     - \n       projects/project/regions/region/disks/disk\n     \n     - \n       zones/zone/disks/disk\n     \n     - \n       regions/region/disks/disk",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupList": {
"description": "Contains a list of InstanceGroup resources.",
"id": "RegionInstanceGroupList",
"properties": {
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of InstanceGroup resources.",
"items": {
"$ref": "InstanceGroup"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupList",
"description": "Output only. The resource type.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagerDeleteInstanceConfigReq": {
"description": "RegionInstanceGroupManagers.deletePerInstanceConfigs",
"id": "RegionInstanceGroupManagerDeleteInstanceConfigReq",
"properties": {
"names": {
"description": "The list of instance names for which we want to delete per-instance configs\non this managed instance group.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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.",
"readOnly": true,
"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\nlist of managed instance groups that exist in th regional scope.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagerPatchInstanceConfigReq": {
"description": "RegionInstanceGroupManagers.patchPerInstanceConfigs",
"id": "RegionInstanceGroupManagerPatchInstanceConfigReq",
"properties": {
"perInstanceConfigs": {
"description": "The list of per-instance configurations to insert or patch on this managed\ninstance group.",
"items": {
"$ref": "PerInstanceConfig"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagerResizeRequestsListResponse": {
"id": "RegionInstanceGroupManagerResizeRequestsListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "Output only. Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of Resize Request resources.",
"items": {
"$ref": "InstanceGroupManagerResizeRequest"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupManagerResizeRequestList",
"description": "Output only. Type of the resource. Alwayscompute#regionInstanceGroupManagerResizeRequestList for\na list of Resize Requests.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagerUpdateInstanceConfigReq": {
"description": "RegionInstanceGroupManagers.updatePerInstanceConfigs",
"id": "RegionInstanceGroupManagerUpdateInstanceConfigReq",
"properties": {
"perInstanceConfigs": {
"description": "The list of per-instance configurations to insert or patch on this managed\ninstance group.",
"items": {
"$ref": "PerInstanceConfig"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersAbandonInstancesRequest": {
"id": "RegionInstanceGroupManagersAbandonInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to abandon. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersApplyUpdatesRequest": {
"description": "RegionInstanceGroupManagers.applyUpdatesToInstances",
"id": "RegionInstanceGroupManagersApplyUpdatesRequest",
"properties": {
"allInstances": {
"description": "Flag to update all instances instead of specified list of \u201cinstances\u201d.\nIf the flag is set to true then the instances may not be specified\nin the request.",
"type": "boolean"
},
"instances": {
"description": "The list of URLs of one or more instances for which you want to apply\nupdates. Each URL can be a full URL or a partial URL, such aszones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
},
"minimalAction": {
"description": "The minimal action that you want to perform on each instance during the\nupdate:\n   \n   \n     - REPLACE: At minimum, delete the instance and create it\n     again. \n   - RESTART: Stop the instance and start it\n     again. \n   - REFRESH: Do not stop the instance and limit\n     disruption as much as possible. \n   - NONE: Do not\n     disrupt the instance at all.\n\n\nBy default, the minimum action is NONE. If your update\nrequires a more disruptive action than you set with this flag, the\nnecessary action is performed to execute the update.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"type": "string"
},
"mostDisruptiveAllowedAction": {
"description": "The most disruptive action that you want to perform on each instance during\nthe update:\n   \n   \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 and limit disruption\n     as much as possible. \n   - NONE: Do not disrupt the\n     instance at all.\n\n\nBy default, the most disruptive allowed action is REPLACE. If\nyour update requires a more disruptive action than you set with this flag,\nthe update request will fail.",
"enum": [
"NONE",
"REFRESH",
"REPLACE",
"RESTART"
],
"enumDescriptions": [
"Do not perform any action.",
"Do not stop the instance.",
"(Default.) Replace the instance according to the replacement method\noption.",
"Stop the instance and start it again."
],
"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\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
},
"skipInstancesOnValidationError": {
"description": "Specifies whether the request should proceed despite the inclusion of\ninstances that are not members of the group or that are already in the\nprocess of being deleted or abandoned. If this field is set to `false` and\nsuch an instance is specified in the request, the operation fails. The\noperation always fails if the request contains a malformed instance URL or\na reference to an instance that exists in a zone or region other than the\ngroup's zone or region.",
"type": "boolean"
}
},
"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. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupManagersListInstanceConfigsResp": {
"id": "RegionInstanceGroupManagersListInstanceConfigsResp",
"properties": {
"items": {
"description": "Output only. [Output Only] The list of PerInstanceConfig.",
"items": {
"$ref": "PerInstanceConfig"
},
"readOnly": true,
"type": "array"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupManagersListInstancesResponse": {
"id": "RegionInstanceGroupManagersListInstancesResponse",
"properties": {
"managedInstances": {
"description": "A list of managed instances.",
"items": {
"$ref": "ManagedInstance"
},
"type": "array"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"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\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersResumeInstancesRequest": {
"id": "RegionInstanceGroupManagersResumeInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to resume. This can be a full URL or\na 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\ncontents. This field is used for optimistic locking when you update the\ntarget pool entries. This field is optional.",
"format": "byte",
"type": "string"
},
"targetPools": {
"description": "The URL of all TargetPool resources to which instances in theinstanceGroup field are added. The target pools automatically\napply 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\ncreated.",
"type": "string"
}
},
"type": "object"
},
"RegionInstanceGroupManagersStartInstancesRequest": {
"id": "RegionInstanceGroupManagersStartInstancesRequest",
"properties": {
"instances": {
"description": "The URLs of one or more instances to start. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersStopInstancesRequest": {
"id": "RegionInstanceGroupManagersStopInstancesRequest",
"properties": {
"forceStop": {
"description": "If this flag is set to true, the Instance Group Manager will proceed to\nstop the instances, skipping initialization on them.",
"type": "boolean"
},
"instances": {
"description": "The URLs of one or more instances to stop. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupManagersSuspendInstancesRequest": {
"id": "RegionInstanceGroupManagersSuspendInstancesRequest",
"properties": {
"forceSuspend": {
"description": "If this flag is set to true, the Instance Group Manager will proceed to\nsuspend the instances, skipping initialization on them.",
"type": "boolean"
},
"instances": {
"description": "The URLs of one or more instances to suspend. This can be a full URL or\na partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RegionInstanceGroupsListInstances": {
"id": "RegionInstanceGroupsListInstances",
"properties": {
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of InstanceWithNamedPorts resources.",
"items": {
"$ref": "InstanceWithNamedPorts"
},
"type": "array"
},
"kind": {
"default": "compute#regionInstanceGroupsListInstances",
"description": "Output only. The resource type.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RegionInstanceGroupsListInstancesRequest": {
"id": "RegionInstanceGroupsListInstancesRequest",
"properties": {
"instanceState": {
"description": "Instances in which state should be returned. Valid options are:\n'ALL', 'RUNNING'. By default, it lists all instances.",
"enum": [
"ALL",
"RUNNING"
],
"enumDescriptions": [
"Matches any status of the instances, running, non-running and others.",
"Instance is in RUNNING state if it is running."
],
"type": "string"
},
"portName": {
"description": "Name of port user is interested in. It is optional. If it is set, only\ninformation about this ports will be returned. If it is not set, all the\nnamed ports will be returned.\nAlways 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.\nUse this optional property to prevent conflicts when multiple users change\nthe named ports settings concurrently. Obtain the fingerprint with theinstanceGroups.get\nmethod. Then, include the fingerprint in your request to ensure that you\ndo not overwrite changes that were applied from another\nconcurrent 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. [Output Only] Type of resource. Always compute#regionList for\nlists of regions.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RegionNetworkEndpointGroupsAttachEndpointsRequest": {
"id": "RegionNetworkEndpointGroupsAttachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be attached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"RegionNetworkEndpointGroupsDetachEndpointsRequest": {
"id": "RegionNetworkEndpointGroupsDetachEndpointsRequest",
"properties": {
"networkEndpoints": {
"description": "The list of network endpoints to be detached.",
"items": {
"$ref": "NetworkEndpoint"
},
"type": "array"
}
},
"type": "object"
},
"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": {
"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse",
"properties": {
"firewallPolicys": {
"description": "Output only. [Output only] Effective firewalls from firewall policy. It applies to\nRegional Network Firewall Policies in the specified region, Global Network\nFirewall Policies and Hierachial Firewall Policies which are associated\nwith the network.",
"items": {
"$ref": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy"
},
"readOnly": true,
"type": "array"
},
"firewalls": {
"description": "Effective firewalls on the network.",
"items": {
"$ref": "Firewall"
},
"type": "array"
}
},
"type": "object"
},
"RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy": {
"id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponseEffectiveFirewallPolicy",
"properties": {
"displayName": {
"description": "Output only. [Output Only] The display name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of the firewall policy.",
"readOnly": true,
"type": "string"
},
"packetMirroringRules": {
"description": "Output only. [Output only] The packet mirroring rules that apply to the network.",
"items": {
"$ref": "FirewallPolicyRule"
},
"readOnly": true,
"type": "array"
},
"priority": {
"description": "Output only. [Output only] Priority of firewall policy association. Not applicable for\ntype=HIERARCHY.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"rules": {
"description": "Output only. [Output only] The rules that apply to the network.",
"items": {
"$ref": "FirewallPolicyRule"
},
"readOnly": true,
"type": "array"
},
"type": {
"description": "Output only. [Output Only] The type of the firewall policy. Can be one of HIERARCHY,\nNETWORK, NETWORK_REGIONAL, SYSTEM_GLOBAL, SYSTEM_REGIONAL.",
"enum": [
"HIERARCHY",
"NETWORK",
"NETWORK_REGIONAL",
"SYSTEM_GLOBAL",
"SYSTEM_REGIONAL",
"UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RegionSetLabelsRequest": {
"id": "RegionSetLabelsRequest",
"properties": {
"labelFingerprint": {
"description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You must\nalways provide an up-to-date fingerprint hash in order to update or change\nlabels. Make a get() request to the resource to get the latest\nfingerprint.",
"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.\nDeprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. 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\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"RegionSnapshotUpdateKmsKeyRequest": {
"id": "RegionSnapshotUpdateKmsKeyRequest",
"properties": {
"kmsKeyName": {
"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n   \n   \n     - projects/project_id/locations/region/keyRings/region/cryptoKeys/key",
"type": "string"
}
},
"type": "object"
},
"RegionTargetHttpsProxiesSetSslCertificatesRequest": {
"id": "RegionTargetHttpsProxiesSetSslCertificatesRequest",
"properties": {
"sslCertificates": {
"description": "New set of SslCertificate resources to associate\nwith this TargetHttpsProxy resource.",
"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\nare shadowed to a separate mirrored backend service. The load balancer\ndoesn't wait for responses from the shadow service. Before sending traffic\nto the shadow service, the host or authority header is suffixed with-shadow.",
"id": "RequestMirrorPolicy",
"properties": {
"backendService": {
"description": "The full or partial URL to the BackendService resource being\nmirrored to.\n\nThe backend service configured for a mirroring\npolicy must reference backends that are of the same type as the original\nbackend service matched in the URL map.\n\nServerless NEG backends are not currently supported as a mirrored\nbackend service.",
"type": "string"
},
"mirrorPercent": {
"description": "The percentage of requests to be mirrored to `backend_service`.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Reservation": {
"description": "Represents a reservation resource.  A reservation ensures that capacity is\nheld in a specific zone even if the reserved VMs are not running. For more\ninformation, read  Reserving zonal\nresources.",
"id": "Reservation",
"properties": {
"advancedDeploymentControl": {
"$ref": "ReservationAdvancedDeploymentControl",
"description": "Advanced control for cluster management, applicable only to DENSE\ndeployment type reservations."
},
"aggregateReservation": {
"$ref": "AllocationAggregateReservation",
"description": "Reservation for aggregated resources, providing shape flexibility."
},
"commitment": {
"description": "Output only. [Output Only] Full or partial URL to a parent commitment. This field\ndisplays for reservations that are tied to a commitment.",
"readOnly": true,
"type": "string"
},
"confidentialComputeType": {
"enum": [
"CONFIDENTIAL_COMPUTE_TYPE_TDX",
"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Intel Trust Domain Extensions.",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"deleteAfterDuration": {
"$ref": "Duration",
"description": "Duration time relative to reservation creation when Compute Engine will\nautomatically delete this resource."
},
"deleteAtTime": {
"description": "Absolute time in future when the reservation will be\n auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.",
"type": "string"
},
"deploymentType": {
"description": "Specifies the deployment strategy for this reservation.",
"enum": [
"DENSE",
"DEPLOYMENT_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"The reserved capacity is made up of densely deployed reservation blocks.",
""
],
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"earlyAccessMaintenance": {
"description": "Indicates the early access maintenance for the reservation.\nIf this field is absent or set to NO_EARLY_ACCESS, the reservation is not\nenrolled in early access maintenance and the standard notice applies.",
"enum": [
"NO_EARLY_ACCESS",
"WAVE1",
"WAVE2"
],
"enumDescriptions": [
"No early access.",
"Wave 1: Fastest notification period",
"Wave 2: Medium notification period"
],
"type": "string"
},
"enableEmergentMaintenance": {
"description": "Indicates whether Compute Engine allows unplanned maintenance for your VMs;\nfor example, to fix hardware errors.",
"type": "boolean"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#reservation",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.",
"readOnly": true,
"type": "string"
},
"linkedCommitments": {
"description": "Output only. [Output Only] Full or partial URL to parent commitments. This field\ndisplays for reservations that are tied to multiple commitments.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "ReservationParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"protectionTier": {
"description": "Protection tier for the workload which specifies the workload expectations\nin the event of infrastructure failures at data center (e.g. power\nand/or cooling failures).",
"enum": [
"CAPACITY_OPTIMIZED",
"PROTECTION_TIER_UNSPECIFIED",
"STANDARD"
],
"enumDescriptions": [
"CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling)\nat the data center during normal operating conditions. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload may be disrupted. As a consequence, it has a\nweaker availability SLO than STANDARD.",
"Unspecified protection tier.",
"STANDARD protection for workload that should be protected by redundancies\n(e.g. power, cooling) at the data center level. In the event of\ninfrastructure failures at data center (e.g. power and/or cooling\nfailures), this workload is expected to continue as normal using the\nredundancies."
],
"type": "string"
},
"reservationSharingPolicy": {
"$ref": "AllocationReservationSharingPolicy",
"description": "Specify the reservation sharing policy. If unspecified, the reservation\nwill not be shared with Google Cloud managed services."
},
"resourcePolicies": {
"additionalProperties": {
"type": "string"
},
"description": "Resource policies to be added to this reservation. The key is defined by\nuser, and the value is resource policy url. This is to define placement\npolicy with reservation.",
"type": "object"
},
"resourceStatus": {
"$ref": "AllocationResourceStatus",
"description": "Output only. [Output Only] Status information for Reservation resource.",
"readOnly": true
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"schedulingType": {
"description": "The type of maintenance for the reservation.",
"enum": [
"GROUPED",
"GROUP_MAINTENANCE_TYPE_UNSPECIFIED",
"INDEPENDENT"
],
"enumDescriptions": [
"Maintenance on all reserved instances in the reservation is synchronized.",
"Unknown maintenance type.",
"Maintenance is not synchronized for this reservation. Instead, each\ninstance has its own maintenance window."
],
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"shareSettings": {
"$ref": "ShareSettings",
"description": "Specify share-settings to create a shared reservation. This property is\noptional. For more information about the syntax and options for this\nfield and its subfields, see the guide for creating\na shared reservation."
},
"specificReservation": {
"$ref": "AllocationSpecificSKUReservation",
"description": "Reservation for instances with specific machine shapes."
},
"specificReservationRequired": {
"description": "Indicates whether the reservation can be consumed by VMs with affinity\nfor \"any\" reservation. If the field is set, then only VMs that target\nthe reservation by name can consume from this reservation.",
"type": "boolean"
},
"status": {
"description": "Output only. [Output Only] The status of the reservation.\n   \n   \n     - CREATING: Reservation resources are being\n       allocated.\n     - READY: Reservation resources have been allocated,\n       and the reservation is ready for use.\n     - DELETING: Reservation deletion is in progress.\n     - UPDATING: Reservation update is in progress.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY",
"UPDATING"
],
"enumDescriptions": [
"Reservation resources are being allocated.",
"Reservation deletion is in progress.",
"",
"Reservation resources have been allocated, and the reservation is ready\nfor use.",
"Reservation update is in progress."
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Zone in which the reservation resides. A zone must be provided if the\nreservation is created within a commitment.",
"type": "string"
}
},
"type": "object"
},
"ReservationAdvancedDeploymentControl": {
"description": "Advance control for cluster management, applicable only to DENSE deployment\ntype reservations.",
"id": "ReservationAdvancedDeploymentControl",
"properties": {
"reservationOperationalMode": {
"description": "Indicates chosen reservation operational mode for the reservation.",
"enum": [
"ALL_CAPACITY",
"HIGHLY_AVAILABLE_CAPACITY",
"RESERVATION_OPERATIONAL_MODE_UNSPECIFIED"
],
"enumDescriptions": [
"Google Cloud does not manage the failure of machines, but provides\nadditional capacity, which is not guaranteed to be available.",
"Google Cloud manages the failure of machines to provide high\navailability.",
""
],
"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\nresources: ANY_RESERVATION (default),SPECIFIC_RESERVATION, or NO_RESERVATION. See\nConsuming reserved instances for examples.",
"enum": [
"ANY_RESERVATION",
"NO_RESERVATION",
"SPECIFIC_RESERVATION",
"UNSPECIFIED"
],
"enumDescriptions": [
"Consume any allocation available.",
"Do not consume from any allocated capacity.",
"Must consume from a specific reservation. Must specify key value fields\nfor specifying the reservations.",
""
],
"type": "string"
},
"key": {
"description": "Corresponds to the label key of a reservation resource. To target aSPECIFIC_RESERVATION by name, specifygoogleapis.com/reservation-name as the key and specify\nthe name of your reservation as its value.",
"type": "string"
},
"values": {
"description": "Corresponds to the label values of a reservation resource. This can be\neither a name to a reservation in the same project or\n\"projects/different-project/reservations/some-reservation-name\" to target a\nshared reservation in the same zone but in a different project.",
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ReservationBlock": {
"description": "Represents a reservation block resource.",
"id": "ReservationBlock",
"properties": {
"count": {
"description": "Output only. [Output Only] The number of resources that are allocated in this\nreservation block.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"healthInfo": {
"$ref": "ReservationBlockHealthInfo",
"description": "Output only. [Output Only] Health information for the reservation block.",
"readOnly": true
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"inUseCount": {
"description": "Output only. [Output Only] The number of instances that are currently in use on this\nreservation block.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"inUseHostCount": {
"description": "Output only. Number of hosts currently in use. If there is one or more Instances running\non the host, it is considered in use.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"kind": {
"default": "compute#reservationBlock",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#reservationBlock for reservation blocks.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of this reservation block generated by Google\nCompute Engine. The name must be 1-63 characters long, and comply with\nRFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"readOnly": true,
"type": "string"
},
"physicalTopology": {
"$ref": "ReservationBlockPhysicalTopology",
"description": "Output only. [Output Only] The physical topology of the reservation block.",
"readOnly": true
},
"reservationMaintenance": {
"$ref": "GroupMaintenanceInfo",
"description": "Output only. [Output Only] Maintenance information for this reservation block.",
"readOnly": true
},
"reservationSubBlockCount": {
"description": "Output only. [Output Only] The number of reservation subBlocks associated with this\nreservation block.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"reservationSubBlockInUseCount": {
"description": "Output only. [Output Only] The number of in-use reservation subBlocks associated with\nthis reservation block. If at least one VM is running on a subBlock, it is\nconsidered in-use.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] Status of the reservation block.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"Resources are being allocated for the reservation block.",
"Reservation block is currently being deleted.",
"",
"Reservation block has allocated all its resources."
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] Zone in which the reservation block resides.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ReservationBlockHealthInfo": {
"description": "Health information for the reservation block.",
"id": "ReservationBlockHealthInfo",
"properties": {
"degradedSubBlockCount": {
"description": "The number of subBlocks that are degraded.",
"format": "int32",
"type": "integer"
},
"healthStatus": {
"description": "The health status of the reservation block.",
"enum": [
"DEGRADED",
"HEALTHY",
"HEALTH_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The reservation block is degraded.",
"The reservation block is healthy.",
"The health status of the reservation block is unspecified."
],
"type": "string"
},
"healthySubBlockCount": {
"description": "The number of subBlocks that are healthy.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ReservationBlockPhysicalTopology": {
"id": "ReservationBlockPhysicalTopology",
"properties": {
"block": {
"description": "The hash of the capacity block within the cluster.",
"type": "string"
},
"cluster": {
"description": "The cluster name of the reservation block.",
"type": "string"
},
"instances": {
"description": "Output only. The detailed instances information for a given Block",
"items": {
"$ref": "ReservationBlockPhysicalTopologyInstance"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ReservationBlockPhysicalTopologyInstance": {
"description": "The instances information for a given Block",
"id": "ReservationBlockPhysicalTopologyInstance",
"properties": {
"instanceId": {
"description": "The InstanceId of the instance",
"format": "uint64",
"type": "string"
},
"physicalHostTopology": {
"$ref": "ReservationBlockPhysicalTopologyInstancePhysicalHostTopology",
"description": "Output only. The PhysicalHostTopology of instances within a Block resource.",
"readOnly": true
},
"projectId": {
"description": "Project where the instance lives",
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"ReservationBlockPhysicalTopologyInstancePhysicalHostTopology": {
"description": "The PhysicalHostTopology of the instance within a Block resource.",
"id": "ReservationBlockPhysicalTopologyInstancePhysicalHostTopology",
"properties": {
"host": {
"description": "Host hash for a given instance",
"type": "string"
},
"subBlock": {
"description": "Sub block hash for a given instance",
"type": "string"
}
},
"type": "object"
},
"ReservationBlocksGetResponse": {
"id": "ReservationBlocksGetResponse",
"properties": {
"resource": {
"$ref": "ReservationBlock"
}
},
"type": "object"
},
"ReservationBlocksListResponse": {
"description": "A list of reservation blocks under a single reservation.",
"id": "ReservationBlocksListResponse",
"properties": {
"id": {
"description": "Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of reservation block resources.",
"items": {
"$ref": "ReservationBlock"
},
"type": "array"
},
"kind": {
"default": "compute#reservationBlock",
"description": "Type of the resource. Alwayscompute#reservationBlock for a list of reservation blocks.",
"type": "string"
},
"nextPageToken": {
"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\ndefined 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. [Output Only] Type of resource.Always compute#reservationsList\nfor listsof reservations",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ReservationParams": {
"description": "Additional reservation params.",
"id": "ReservationParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the reservation. Tag keys and\nvalues have the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"ReservationSlot": {
"description": "Represents a reservation slot resource.",
"id": "ReservationSlot",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] The creation timestamp, formatted asRFC3339 text.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for this resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#reservationSlot",
"description": "Output only. [Output Only] The type of resource. Alwayscompute#reservationSlot for reservation slots.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of the reservation slot.",
"readOnly": true,
"type": "string"
},
"physicalTopology": {
"$ref": "ReservationSlotPhysicalTopology",
"deprecated": true,
"description": "Output only. [Output Only] The physical topology of the reservation slot.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] A server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] A server-defined URL for this resource with the resource ID.",
"readOnly": true,
"type": "string"
},
"shareSettings": {
"$ref": "ShareSettings",
"description": "Specify share settings to create a shared slot. Set to empty\nto inherit the share settings from a parent resource."
},
"state": {
"description": "Output only. [Output Only] The state of the reservation slot.",
"enum": [
"ACTIVE",
"CREATING",
"DELETING",
"STATE_UNSPECIFIED",
"UNAVAILABLE"
],
"enumDescriptions": [
"The reservation slot has allocated all its resources.",
"The resources are being allocated for the reservation slot.",
"The reservation slot is currently being deleted.",
"",
"The reservation slot is currently unavailable."
],
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "ReservationSlotStatus",
"description": "Output only. [Output Only] The status of the reservation slot.",
"readOnly": true
},
"zone": {
"description": "Output only. [Output Only] The zone in which the reservation slot resides.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ReservationSlotPhysicalTopology": {
"id": "ReservationSlotPhysicalTopology",
"properties": {
"block": {
"description": "The unique identifier of the capacity block within the cluster.",
"type": "string"
},
"cluster": {
"description": "The cluster name of the reservation sub-block.",
"type": "string"
},
"host": {
"description": "The unique identifier of the capacity host within the capacity sub-block.",
"type": "string"
},
"subBlock": {
"description": "The unique identifier of the capacity sub-block within the capacity\nblock.",
"type": "string"
}
},
"type": "object"
},
"ReservationSlotStatus": {
"id": "ReservationSlotStatus",
"properties": {
"physicalTopology": {
"$ref": "ReservationSlotPhysicalTopology",
"description": "Output only. [Output Only] The physical topology of the reservation sub-block.",
"readOnly": true
},
"rdmaIpAddresses": {
"description": "Output only. The RDMA IP address of the physical host.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"runningInstances": {
"description": "Output only. The URIs of the instances currently running on this slot.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ReservationSlotsGetResponse": {
"id": "ReservationSlotsGetResponse",
"properties": {
"resource": {
"$ref": "ReservationSlot"
}
},
"type": "object"
},
"ReservationSlotsGetVersionRequest": {
"id": "ReservationSlotsGetVersionRequest",
"properties": {
"sbomSelections": {
"description": "The SBOM selection to return. Duplicate values in the list will be ignored.",
"items": {
"enum": [
"SBOM_SELECTION_CURRENT",
"SBOM_SELECTION_TARGET",
"SBOM_SELECTION_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ReservationSlotsListResponse": {
"description": "A list of reservation slots within a single reservation.",
"id": "ReservationSlotsListResponse",
"properties": {
"id": {
"description": "The unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of reservation slot resources.",
"items": {
"$ref": "ReservationSlot"
},
"type": "array"
},
"kind": {
"default": "compute#reservationSlot",
"description": "The type of resource. Alwayscompute#reservationSlot for a list of reservation\nslots.",
"type": "string"
},
"nextPageToken": {
"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "The server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "An informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ReservationSubBlock": {
"description": "Represents a reservation subBlock resource.",
"id": "ReservationSubBlock",
"properties": {
"acceleratorTopologiesInfo": {
"$ref": "AcceleratorTopologiesInfo",
"description": "Output only. [Output Only] Slice info for the reservation subBlock.",
"readOnly": true
},
"count": {
"description": "Output only. [Output Only] The number of hosts that are allocated in this\nreservation subBlock.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"healthInfo": {
"$ref": "ReservationSubBlockHealthInfo",
"description": "Output only. [Output Only] Health information for the reservation subBlock.",
"readOnly": true
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"inUseCount": {
"description": "Output only. [Output Only] The number of instances that are currently in use on this\nreservation subBlock.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"inUseHostCount": {
"description": "Output only. Number of hosts currently in use. If there is one or more Instances running\non the host, it is considered in use.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"kind": {
"default": "compute#reservationSubBlock",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#reservationSubBlock for reservation subBlocks.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of this reservation subBlock generated by Google\nCompute Engine. The name must be 1-63 characters long, and comply with\nRFC1035 @pattern [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"readOnly": true,
"type": "string"
},
"physicalTopology": {
"$ref": "ReservationSubBlockPhysicalTopology",
"description": "Output only. [Output Only] The physical topology of the reservation subBlock.",
"readOnly": true
},
"reservationSubBlockMaintenance": {
"$ref": "GroupMaintenanceInfo",
"description": "Output only. Maintenance information for this reservation subBlock.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] Status of the reservation subBlock.",
"enum": [
"CREATING",
"DELETING",
"INVALID",
"READY"
],
"enumDescriptions": [
"Resources are being allocated for the reservation subBlock.",
"Reservation subBlock is currently being deleted.",
"",
"Reservation subBlock has allocated all its resources."
],
"readOnly": true,
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] Zone in which the reservation subBlock resides.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ReservationSubBlockHealthInfo": {
"description": "Health information for the reservation subBlock.",
"id": "ReservationSubBlockHealthInfo",
"properties": {
"degradedHostCount": {
"description": "The number of degraded hosts in the reservation subBlock.",
"format": "int32",
"type": "integer"
},
"degradedInfraCount": {
"description": "The number of degraded infrastructure (e.g NV link domain) in the\nreservation subblock.",
"format": "int32",
"type": "integer"
},
"healthStatus": {
"description": "The health status of the reservation subBlock.",
"enum": [
"DEGRADED",
"HEALTHY",
"HEALTH_STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The reservation subBlock is degraded.",
"The reservation subBlock is healthy.",
"The health status of the reservation subBlock is unspecified."
],
"type": "string"
},
"healthyHostCount": {
"description": "The number of healthy hosts in the reservation subBlock.",
"format": "int32",
"type": "integer"
},
"healthyInfraCount": {
"description": "The number of healthy infrastructure (e.g NV link domain) in the\nreservation subblock.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ReservationSubBlockPhysicalTopology": {
"id": "ReservationSubBlockPhysicalTopology",
"properties": {
"block": {
"description": "The hash of the capacity block within the cluster.",
"type": "string"
},
"cluster": {
"description": "The cluster name of the reservation subBlock.",
"type": "string"
},
"subBlock": {
"description": "The hash of the capacity sub-block within the capacity block.",
"type": "string"
}
},
"type": "object"
},
"ReservationSubBlocksGetResponse": {
"id": "ReservationSubBlocksGetResponse",
"properties": {
"resource": {
"$ref": "ReservationSubBlock"
}
},
"type": "object"
},
"ReservationSubBlocksGetVersionRequest": {
"id": "ReservationSubBlocksGetVersionRequest",
"properties": {
"sbomSelections": {
"description": "The SBOM selection to return.",
"items": {
"enum": [
"SBOM_SELECTION_CURRENT",
"SBOM_SELECTION_TARGET",
"SBOM_SELECTION_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ReservationSubBlocksListResponse": {
"description": "A list of reservation subBlocks under a single reservation.",
"id": "ReservationSubBlocksListResponse",
"properties": {
"id": {
"description": "Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of reservation subBlock resources.",
"items": {
"$ref": "ReservationSubBlock"
},
"type": "array"
},
"kind": {
"default": "compute#reservationSubBlock",
"description": "Type of the resource. Alwayscompute#reservationSubBlock for a list of reservation\nsubBlocks.",
"type": "string"
},
"nextPageToken": {
"description": "This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Server-defined URL for this resource.",
"type": "string"
},
"warning": {
"description": "Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ReservationSubBlocksReportFaultyRequest": {
"id": "ReservationSubBlocksReportFaultyRequest",
"properties": {
"disruptionSchedule": {
"description": "The disruption schedule for the subBlock.",
"enum": [
"DISRUPTION_SCHEDULE_UNSPECIFIED",
"IMMEDIATE"
],
"enumDescriptions": [
"",
"All VMs will be disrupted immediately."
],
"type": "string"
},
"failureComponent": {
"description": "The component that experienced the fault.",
"enum": [
"FAILURE_COMPONENT_UNSPECIFIED",
"MULTIPLE_FAULTY_HOSTS",
"NVLINK_SWITCH"
],
"enumDescriptions": [
"",
"Multiple hosts experienced the fault.",
"The NVLink switch experienced the fault."
],
"type": "string"
},
"faultReasons": {
"description": "The reasons for the fault experienced with the subBlock.",
"items": {
"$ref": "ReservationSubBlocksReportFaultyRequestFaultReason"
},
"type": "array"
}
},
"type": "object"
},
"ReservationSubBlocksReportFaultyRequestFaultReason": {
"description": "The reason for the fault experienced with the subBlock.",
"id": "ReservationSubBlocksReportFaultyRequestFaultReason",
"properties": {
"behavior": {
"description": "The behavior of the fault experienced with the subBlock.",
"enum": [
"FAULT_BEHAVIOR_UNSPECIFIED",
"GPU_ERROR",
"PERFORMANCE",
"SILENT_DATA_CORRUPTION",
"SWITCH_FAILURE"
],
"enumDescriptions": [
"",
"The subBlock experienced a GPU error.",
"The subBlock experienced performance issues.",
"The subBlock experienced silent data corruption.",
"The subBlock experienced a switch failure."
],
"type": "string"
},
"description": {
"description": "The description of the fault experienced with the subBlock.",
"type": "string"
}
},
"type": "object"
},
"ReservationsBlocksPerformMaintenanceRequest": {
"id": "ReservationsBlocksPerformMaintenanceRequest",
"properties": {
"maintenanceScope": {
"description": "Specifies if all, running or unused hosts are in scope for this request.",
"enum": [
"ALL",
"MAINTENANCE_SCOPE_UNSPECIFIED",
"RUNNING_VMS",
"UNUSED_CAPACITY"
],
"enumDescriptions": [
"Trigger maintenance for all hosts belonging to this reservation\nirrespective of whether VMs are running on them or not.",
"Internal only",
"Trigger maintenance only on the hosts belonging to this reservation which\nhave VMs running on them.",
"Trigger maintenance only on the hosts belonging to this reservation which\ndo not have any VMs running on them. This is not allowed for Standard ExR"
],
"type": "string"
}
},
"type": "object"
},
"ReservationsPerformMaintenanceRequest": {
"id": "ReservationsPerformMaintenanceRequest",
"properties": {
"maintenanceScope": {
"description": "Specifies if all, running or unused hosts are in scope for this request.",
"enum": [
"ALL",
"MAINTENANCE_SCOPE_UNSPECIFIED",
"RUNNING_VMS",
"UNUSED_CAPACITY"
],
"enumDescriptions": [
"Trigger maintenance for all hosts belonging to this reservation\nirrespective of whether VMs are running on them or not.",
"Internal only",
"Trigger maintenance only on the hosts belonging to this reservation which\nhave VMs running on them.",
"Trigger maintenance only on the hosts belonging to this reservation which\ndo not have any VMs running on them. This is not allowed for Standard ExR"
],
"type": "string"
}
},
"type": "object"
},
"ReservationsResizeRequest": {
"id": "ReservationsResizeRequest",
"properties": {
"specificSkuCount": {
"description": "Number of allocated resources can be resized with minimum = 1 and\nmaximum = 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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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 hardware resource (a commitment is composed of\none or more of these).",
"id": "ResourceCommitment",
"properties": {
"acceleratorType": {
"description": "Name of the accelerator type or GPU resource. Specify this field only when\nthe type of hardware resource is ACCELERATOR.",
"type": "string"
},
"amount": {
"description": "The quantity of the hardware resource that you want to commit to purchasing\n(in a type-dependent unit).\n   \n   - For vCPUs, you must specify an integer value.\n   - For memory, you specify the amount of MB that you want. The value you\n   specify must be a multiple of 256 MB, with up to 6.5 GB of\n   memory per every vCPU.\n   - For GPUs, you must specify an integer value.\n   - For Local SSD disks, you must specify the amount in GB. The size of a\n   single Local SSD disk is 375 GB.",
"format": "int64",
"type": "string"
},
"type": {
"description": "The type of hardware resource that you want to specify.\nYou can specify any of the following values:\n   \n   - VCPU\n   - MEMORY\n   - LOCAL_SSD\n   - ACCELERATOR\n\n\n\nSpecify as a separate entry in the list for each\nindividual resource type.",
"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\nlisted 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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nschedule actions for some Compute Engine resources. For example, you can\nuse them toschedule persistent disk\nsnapshots.",
"id": "ResourcePolicy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"type": "string"
},
"diskConsistencyGroupPolicy": {
"$ref": "ResourcePolicyDiskConsistencyGroupPolicy",
"description": "Resource policy for disk consistency groups."
},
"groupPlacementPolicy": {
"$ref": "ResourcePolicyGroupPlacementPolicy",
"description": "Resource policy for instances for placement configuration."
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceSchedulePolicy": {
"$ref": "ResourcePolicyInstanceSchedulePolicy",
"description": "Resource policy for scheduling instance operations."
},
"kind": {
"default": "compute#resourcePolicy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#resource_policies for resource policies.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.instances.insert"
]
},
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The resource name must be 1-63 characters long, and comply\nwithRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"readOnly": true,
"type": "string"
},
"resourceStatus": {
"$ref": "ResourcePolicyResourceStatus",
"description": "Output only. [Output Only] The system status of the resource policy.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"snapshotSchedulePolicy": {
"$ref": "ResourcePolicySnapshotSchedulePolicy",
"description": "Resource policy for persistent disks for creating snapshots."
},
"status": {
"description": "Output only. [Output Only] The status of resource policy creation.",
"enum": [
"CREATING",
"DELETING",
"EXPIRED",
"INVALID",
"READY"
],
"enumDescriptions": [
"Resource policy is being created.",
"Resource policy is being deleted.",
"Resource policy is expired and will not run again.",
"",
"Resource policy is ready to be used."
],
"readOnly": true,
"type": "string"
},
"workloadPolicy": {
"$ref": "ResourcePolicyWorkloadPolicy",
"description": "Resource policy for defining instance placement for MIGs."
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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 days. The value determines\nhow many days pass between the start of each cycle.",
"format": "int32",
"type": "integer"
},
"duration": {
"description": "Output only. [Output only] A predetermined duration for the window, automatically\nchosen to be the smallest possible in the given scenario.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Start time of the window. This must be in UTC format that resolves to one\nof 00:00, 04:00, 08:00,12:00, 16:00, or 20:00. For\nexample, both 13:00-5 and 08:00 are valid.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyDiskConsistencyGroupPolicy": {
"description": "Resource policy for disk consistency groups.",
"id": "ResourcePolicyDiskConsistencyGroupPolicy",
"properties": {},
"type": "object"
},
"ResourcePolicyGroupPlacementPolicy": {
"description": "A GroupPlacementPolicy specifies resource placement configuration.\nIt specifies the failure bucket separation",
"id": "ResourcePolicyGroupPlacementPolicy",
"properties": {
"acceleratorTopologyMode": {
"description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.",
"enum": [
"AUTO_CONNECT",
"PROVISION_ONLY"
],
"enumDescriptions": [
"The interconnected chips are pre-configured at the time of VM creation.",
"The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected."
],
"type": "string"
},
"availabilityDomainCount": {
"description": "The number of availability domains to spread instances across. If two\ninstances are in different availability domain, they are not in the same\nlow latency network.",
"format": "int32",
"type": "integer"
},
"collocation": {
"description": "Specifies network collocation",
"enum": [
"COLLOCATED",
"UNSPECIFIED_COLLOCATION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"gpuTopology": {
"description": "Specifies the shape of the GPU slice, in slice based GPU families eg.\nA4X.",
"type": "string"
},
"vmCount": {
"description": "Number of VMs in this placement group. Google does not recommend that you\nuse this field unless you use a compact policy and you want your policy\nto work only if it contains this exact number of VMs.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"ResourcePolicyHourlyCycle": {
"description": "Time window specified for hourly operations.",
"id": "ResourcePolicyHourlyCycle",
"properties": {
"duration": {
"description": "Output only. [Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.",
"readOnly": true,
"type": "string"
},
"hoursInCycle": {
"description": "Defines a schedule with units measured in hours. The value determines\nhow many hours pass between the start of each cycle.",
"format": "int32",
"type": "integer"
},
"startTime": {
"description": "Time within the window to start the operations.\nIt must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyInstanceSchedulePolicy": {
"description": "An InstanceSchedulePolicy specifies when and how frequent certain\noperations are performed on the instance.",
"id": "ResourcePolicyInstanceSchedulePolicy",
"properties": {
"expirationTime": {
"description": "The expiration time of the schedule. The timestamp is an RFC3339 string.",
"type": "string"
},
"startTime": {
"description": "The start time of the schedule. The timestamp is an RFC3339 string.",
"type": "string"
},
"timeZone": {
"description": "Specifies the time zone to be used in interpreting Schedule.schedule.\nThe value of this field must be a time zone name from the tz database:\nhttps://wikipedia.org/wiki/Tz_database.",
"type": "string"
},
"vmStartSchedule": {
"$ref": "ResourcePolicyInstanceSchedulePolicySchedule",
"description": "Specifies the schedule for starting instances."
},
"vmStopSchedule": {
"$ref": "ResourcePolicyInstanceSchedulePolicySchedule",
"description": "Specifies the schedule for stopping instances."
}
},
"type": "object"
},
"ResourcePolicyInstanceSchedulePolicySchedule": {
"description": "Schedule for an instance operation.",
"id": "ResourcePolicyInstanceSchedulePolicySchedule",
"properties": {
"schedule": {
"description": "Specifies the frequency for the operation, using the unix-cron format.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyList": {
"id": "ResourcePolicyList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined 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. [Output Only] Type of resource.Alwayscompute#resourcePoliciesList for listsof resourcePolicies",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ResourcePolicyResourceStatus": {
"description": "Contains output only fields.\nUse this sub-message for all output fields set on ResourcePolicy.\nThe internal structure of this \"status\" field should mimic the structure\nof ResourcePolicy proto specification.",
"id": "ResourcePolicyResourceStatus",
"properties": {
"instanceSchedulePolicy": {
"$ref": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
"description": "Output only. [Output Only] Specifies a set of output values reffering to\nthe instance_schedule_policy system status.\nThis field should have the same name as corresponding policy field.",
"readOnly": true
}
},
"type": "object"
},
"ResourcePolicyResourceStatusInstanceSchedulePolicyStatus": {
"id": "ResourcePolicyResourceStatusInstanceSchedulePolicyStatus",
"properties": {
"lastRunStartTime": {
"description": "Output only. [Output Only] The last time the schedule successfully ran.\nThe timestamp is an RFC3339 string.",
"readOnly": true,
"type": "string"
},
"nextRunStartTime": {
"description": "Output only. [Output Only] The next time the schedule is planned to run.\nThe actual time might be slightly different.\nThe timestamp is an RFC3339 string.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ResourcePolicySnapshotSchedulePolicy": {
"description": "A snapshot schedule policy specifies when and how frequently snapshots are\nto be created for the target disk. Also specifies how many and how long\nthese 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\nmaintenance we are allowed to perform on this VM and when. Schedule\nthat is applied to disks covered by this policy."
},
"snapshotProperties": {
"$ref": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
"description": "Properties with which snapshots are created such as labels, encryption\nkeys."
}
},
"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\nthe 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\npolicy.",
"id": "ResourcePolicySnapshotSchedulePolicySnapshotProperties",
"properties": {
"chainName": {
"description": "Chain name that the snapshot is created in.",
"type": "string"
},
"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\nby the setLabels method. Label values may be empty.",
"type": "object"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the auto snapshot (regional or\nmulti-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\none or more days. The following options are available:\nMONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY.",
"enum": [
"FRIDAY",
"INVALID",
"MONDAY",
"SATURDAY",
"SUNDAY",
"THURSDAY",
"TUESDAY",
"WEDNESDAY"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"duration": {
"description": "Output only. [Output only] Duration of the time window, automatically chosen to be\nsmallest possible in the given scenario.",
"readOnly": true,
"type": "string"
},
"startTime": {
"description": "Time within the window to start the operations.\nIt must be in format \"HH:MM\", where HH : [00-23] and MM : [00-00] GMT.",
"type": "string"
}
},
"type": "object"
},
"ResourcePolicyWorkloadPolicy": {
"description": "Represents the workload policy.",
"id": "ResourcePolicyWorkloadPolicy",
"properties": {
"acceleratorTopology": {
"description": "Specifies the topology required to create a partition for VMs that have\ninterconnected GPUs.",
"type": "string"
},
"acceleratorTopologyMode": {
"description": "Specifies the connection mode for the accelerator topology. If not\nspecified, the default is AUTO_CONNECT.",
"enum": [
"AUTO_CONNECT",
"PROVISION_ONLY"
],
"enumDescriptions": [
"The interconnected chips are pre-configured at the time of VM creation.",
"The interconnected chips are connected on demand. At the time of VM\ncreation, the chips are not connected."
],
"type": "string"
},
"maxTopologyDistance": {
"description": "Specifies the maximum distance between instances.",
"enum": [
"BLOCK",
"CLUSTER",
"SUBBLOCK"
],
"enumDescriptions": [
"VMs must be provisioned in the same block.",
"VMs must be provisioned in the same cluster.",
"VMs must be provisioned in the same subblock."
],
"type": "string"
},
"type": {
"description": "Specifies the intent of the instance placement in the MIG.",
"enum": [
"HIGH_AVAILABILITY",
"HIGH_THROUGHPUT"
],
"enumDescriptions": [
"MIG spreads out the instances as much as possible for high availability.",
"MIG provisions instances as close to each other as possible for high\nthroughput."
],
"type": "string"
}
},
"type": "object"
},
"ResourceStatus": {
"description": "Contains output only fields.\nUse this sub-message for actual values set on Instance attributes as compared\nto the value requested by the user (intent) in their instance CRUD calls.",
"id": "ResourceStatus",
"properties": {
"effectiveInstanceMetadata": {
"$ref": "ResourceStatusEffectiveInstanceMetadata",
"description": "Output only. [Output Only] Effective metadata is a field that consolidates project,\nzonal instance settings, and instance-level predefined metadata keys to\nprovide the overridden value for those metadata keys at the instance level.",
"readOnly": true
},
"physicalHost": {
"description": "Output only. [Output Only] The precise location of your instance within the zone's data\ncenter, including the block, sub-block, and host. The field is formatted as\nfollows: blockId/subBlockId/hostId.",
"readOnly": true,
"type": "string"
},
"physicalHostTopology": {
"$ref": "ResourceStatusPhysicalHostTopology",
"description": "Output only. [Output Only] A series of fields containing the global name of the Compute\nEngine cluster, as well as the ID of the block, sub-block, and host on\nwhich the running instance is located.",
"readOnly": true
},
"reservationConsumptionInfo": {
"$ref": "ResourceStatusReservationConsumptionInfo",
"description": "Output only. [Output Only] Reservation information that the instance is consuming from.",
"readOnly": true
},
"scheduling": {
"$ref": "ResourceStatusScheduling"
},
"upcomingMaintenance": {
"$ref": "UpcomingMaintenance",
"readOnly": true
}
},
"type": "object"
},
"ResourceStatusEffectiveInstanceMetadata": {
"description": "Effective values of predefined metadata keys for an instance.",
"id": "ResourceStatusEffectiveInstanceMetadata",
"properties": {
"blockProjectSshKeysMetadataValue": {
"description": "Effective block-project-ssh-keys value at Instance level.",
"type": "boolean"
},
"enableGuestAttributesMetadataValue": {
"description": "Effective enable-guest-attributes value at Instance level.",
"type": "boolean"
},
"enableOsInventoryMetadataValue": {
"description": "Effective enable-os-inventory value at Instance level.",
"type": "boolean"
},
"enableOsconfigMetadataValue": {
"description": "Effective enable-osconfig value at Instance level.",
"type": "boolean"
},
"enableOsloginMetadataValue": {
"description": "Effective enable-oslogin value at Instance level.",
"type": "boolean"
},
"gceContainerDeclarationMetadataValue": {
"description": "Effective gce-container-declaration value at Instance level.",
"type": "boolean"
},
"serialPortEnableMetadataValue": {
"description": "Effective serial-port-enable value at Instance level.",
"type": "boolean"
},
"serialPortLoggingEnableMetadataValue": {
"description": "Effective serial-port-logging-enable value at Instance level.",
"type": "boolean"
},
"vmDnsSettingMetadataValue": {
"description": "Effective VM DNS setting at Instance level.",
"type": "string"
}
},
"type": "object"
},
"ResourceStatusPhysicalHostTopology": {
"description": "Represents the physical host topology of the host on which the VM is\nrunning.",
"id": "ResourceStatusPhysicalHostTopology",
"properties": {
"block": {
"description": "[Output Only] The ID of the block in which the running instance is\nlocated. Instances within the same block experience low network latency.",
"type": "string"
},
"cluster": {
"description": "[Output Only] The global name of the Compute Engine cluster where the\nrunning instance is located.",
"type": "string"
},
"host": {
"description": "[Output Only] The ID of the host on which the running instance is located.\nInstances on the same host experience the lowest possible network\nlatency.",
"type": "string"
},
"subblock": {
"description": "[Output Only] The ID of the sub-block in which the running instance is\nlocated. Instances in the same sub-block experience lower network latency\nthan instances in the same block.",
"type": "string"
}
},
"type": "object"
},
"ResourceStatusReservationConsumptionInfo": {
"description": "Reservation consumption information that the instance is consuming from.",
"id": "ResourceStatusReservationConsumptionInfo",
"properties": {
"consumedReservation": {
"description": "Output only. [Output Only] The full resource name of the reservation that this\ninstance is consuming from.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ResourceStatusScheduling": {
"id": "ResourceStatusScheduling",
"properties": {
"availabilityDomain": {
"description": "Specifies the availability domain to place the instance in. The value\nmust be a number between 1 and the number of availability domains\nspecified in the spread placement policy attached to the instance.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Rollout": {
"description": "Rollout resource.\n\nA Rollout is a specific instance of a RolloutPlan. It represents a single\nexecution of a strategy to roll out a specific resource. It also provides\nAPIs to interact with the rollout.",
"id": "Rollout",
"properties": {
"cancellationTime": {
"description": "Output only. The timestamp at which the Rollout was cancelled.",
"readOnly": true,
"type": "string"
},
"completionTime": {
"description": "Output only. The timestamp at which the Rollout was completed.",
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"currentWaveNumber": {
"description": "Output only. The number of the currently running wave.\nEx. 1",
"format": "int64",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"etag": {
"description": "Output only. etag of the Rollout\nEx. abc1234",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#rollout",
"description": "Output only. [Output Only] Type of the resource. Always compute#rollout\nfor rollouts.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"rolloutEntity": {
"$ref": "RolloutRolloutEntity",
"description": "Required. The resource being rolled out."
},
"rolloutPlan": {
"description": "Required. Rollout Plan used to model the Rollout.\nEx. compute.googleapis.com/v1/projects/1234/rolloutPlans/rp1",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The current state of the Rollout.",
"enum": [
"CANCELLED",
"CANCELLING",
"CANCEL_FAILED",
"COMPLETED",
"COMPLETE_FAILED",
"COMPLETING",
"FAILED",
"PAUSED",
"PAUSE_FAILED",
"PAUSING",
"PROCESSING",
"READY",
"RESUMING",
"ROLLBACK_WAVE_FAILED",
"ROLLING_BACK",
"STATE_UNSPECIFIED",
"UNINITIALIZED",
"WAVE_FAILED"
],
"enumDescriptions": [
"The rollout is in a failure terminal state.",
"The rollout is being cancelled.",
"An attempted cancel operation was unsuccessful.",
"The rollout is in a successful terminal state.",
"An attempted complete operation was unsuccessful.",
"The rollout is being marked as completed.",
"The rollout completed with failures.",
"The rollout is paused.",
"An attempted pause operation was unsuccessful.",
"The rollout is being paused.",
"A wave is being processed by the product.",
"The rollout has been successfully initialized and is ready to start.",
"The rollout is being resumed after being paused.",
"An attempted rollback operation failed to complete successfully.",
"A wave rollback is in progress for this rollout.",
"Undefined default state. Should never be exposed to users.",
"The rollout has been created but is not yet ready to be started.",
"The product failed to process the wave."
],
"readOnly": true,
"type": "string"
},
"waveDetails": {
"description": "Output only. Details about each wave of the rollout.",
"items": {
"$ref": "RolloutWaveDetails"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"RolloutPlan": {
"description": "RolloutPlan resource.\n\nA RolloutPlan is the customer-defined strategy to divide a large-scale change\ninto smaller increments, referred to as \"waves\". Each wave targets a specific\nportion of the overall affected area and defines criteria that must be met\nbefore progressing to the subsequent wave.",
"id": "RolloutPlan",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#rolloutPlan",
"description": "Output only. [Output Only] Type of the resource. Always compute#rolloutPlan\nfor rolloutPlans.",
"readOnly": true,
"type": "string"
},
"locationScope": {
"description": "The location scope of the rollout plan. If not specified, the location\nscope is considered as ZONAL.",
"enum": [
"LOCATION_SCOPE_UNSPECIFIED",
"REGIONAL",
"ZONAL"
],
"enumDescriptions": [
"Unspecified value. Considered as ZONAL.",
"Regional scope.",
"Zonal scope."
],
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.rolloutPlans.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"waves": {
"description": "Required. The waves included in this rollout plan.",
"items": {
"$ref": "RolloutPlanWave"
},
"type": "array"
}
},
"type": "object"
},
"RolloutPlanWave": {
"description": "A single wave in a rollout plan.",
"id": "RolloutPlanWave",
"properties": {
"displayName": {
"description": "Optional. The display name of this wave of the rollout plan.",
"type": "string"
},
"number": {
"description": "Output only. The wave number.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"orchestrationOptions": {
"$ref": "RolloutPlanWaveOrchestrationOptions",
"description": "Optional. The orchestration options for this wave."
},
"selectors": {
"description": "Required. The selectors for this wave. There is a logical AND between each selector\ndefined in a wave, so a resource must satisfy the criteria of *all* the\nspecified selectors to be in scope for the wave.",
"items": {
"$ref": "RolloutPlanWaveSelector"
},
"type": "array"
},
"validation": {
"$ref": "RolloutPlanWaveValidation",
"description": "Required. The validation to be performed at the end of this wave."
}
},
"type": "object"
},
"RolloutPlanWaveOrchestrationOptions": {
"description": "Options to control the pace of orchestration of a wave. These options are\nrequired only if the resource being rolled out follows the Orchestrated\npattern.",
"id": "RolloutPlanWaveOrchestrationOptions",
"properties": {
"delays": {
"description": "Optional. Delays, if any, to be added between batches of projects. We allow\nmultiple Delays to be specified, letting users set separate delays\nbetween batches of projects corresponding to different locations and\nbatches of projects corresponding to the same location.",
"items": {
"$ref": "RolloutPlanWaveOrchestrationOptionsDelay"
},
"type": "array"
},
"maxConcurrentLocations": {
"description": "Optional. Maximum number of locations to be orchestrated in parallel.",
"format": "int64",
"type": "string"
},
"maxConcurrentResourcesPerLocation": {
"description": "Optional. Maximum number of resources to be orchestrated per location in\nparallel.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"RolloutPlanWaveOrchestrationOptionsDelay": {
"description": "Options to control the delay, if any, between batches of projects.",
"id": "RolloutPlanWaveOrchestrationOptionsDelay",
"properties": {
"delimiter": {
"description": "Optional. Controls whether the delay should only be added between batches of\nprojects corresponding to different locations, or also between\nbatches of projects corresponding to the same location.\n\nMust be set to DELIMITER_UNSPECIFIED if no delay is to be added.",
"enum": [
"DELIMITER_BATCH",
"DELIMITER_LOCATION",
"DELIMITER_UNSPECIFIED"
],
"enumDescriptions": [
"The delay will also be added between batches of projects\ncorresponding to the same location.",
"The delay will only be added between batches of projects\ncorresponding to different locations.",
"No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done."
],
"type": "string"
},
"duration": {
"description": "Optional. The duration of the delay, if any, to be added between batches of\nprojects. A zero duration corresponds to no delay.",
"format": "google-duration",
"type": "string"
},
"type": {
"description": "Optional. Controls whether the specified duration is to be added at the end of\neach batch, or if the total processing time for each batch will be\npadded if needed to meet the specified duration.\n\nMust be set to TYPE_UNSPECIFIED if no delay is to be added.",
"enum": [
"TYPE_MINIMUM",
"TYPE_OFFSET",
"TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"The total processing time for each batch of projects will be padded\nif needed to meet the specified delay duration.",
"The specified delay will directly be added after each batch of\nprojects as specified by the delimiter.",
"No delay will be added between batches of projects. Processing will\ncontinue with the next batch as soon as the previous batch of LROs\nis done."
],
"type": "string"
}
},
"type": "object"
},
"RolloutPlanWaveSelector": {
"description": "A selector which specifies what resource(s) are included in a given wave.",
"id": "RolloutPlanWaveSelector",
"properties": {
"locationSelector": {
"$ref": "RolloutPlanWaveSelectorLocationSelector",
"description": "Optional. Roll out to resources by Cloud locations."
},
"resourceHierarchySelector": {
"$ref": "RolloutPlanWaveSelectorResourceHierarchySelector",
"description": "Optional. Roll out to resources by Cloud Resource Manager resource hierarchy."
}
},
"type": "object"
},
"RolloutPlanWaveSelectorLocationSelector": {
"description": "Roll out to resources by location.",
"id": "RolloutPlanWaveSelectorLocationSelector",
"properties": {
"includedLocations": {
"description": "Optional. Example: \"us-central1-a\"",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RolloutPlanWaveSelectorResourceHierarchySelector": {
"description": "Roll out to resources by Cloud Resource Manager resource hierarchy\nnodes such as projects, folders, orgs.",
"id": "RolloutPlanWaveSelectorResourceHierarchySelector",
"properties": {
"includedFolders": {
"description": "Optional. Format: \"folders/{folder_id}\"",
"items": {
"type": "string"
},
"type": "array"
},
"includedOrganizations": {
"description": "Optional. Format: \"organizations/{organization_id}\"",
"items": {
"type": "string"
},
"type": "array"
},
"includedProjects": {
"description": "Optional. Format: \"projects/{project_id}\"",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RolloutPlanWaveValidation": {
"description": "The validation to be performed before progressing to the next wave.",
"id": "RolloutPlanWaveValidation",
"properties": {
"timeBasedValidationMetadata": {
"$ref": "RolloutPlanWaveValidationTimeBasedValidationMetadata",
"description": "Optional. Metadata required if type = \"time\"."
},
"type": {
"description": "Required. The type of the validation. If a type of validation is associated with\na metadata object, the appropriate metadata field mapping to the\nvalidation type must be provided in the validation message. Possible\nvalues are in quotes below alongside an explanation:\n  \"manual\": The system waits for an end-user approval API before\n    progressing to the next wave.\n  \"time\": The system waits for a user specified duration before\n    progressing to the next wave. TimeBasedValidation must be provided.",
"type": "string"
}
},
"type": "object"
},
"RolloutPlanWaveValidationTimeBasedValidationMetadata": {
"description": "Metadata required if type = \"time\".",
"id": "RolloutPlanWaveValidationTimeBasedValidationMetadata",
"properties": {
"waitDuration": {
"description": "Optional. The duration that the system waits in between waves. This wait starts\nafter all changes in the wave are rolled out.",
"format": "google-duration",
"type": "string"
}
},
"type": "object"
},
"RolloutPlansListResponse": {
"description": "Contains a list of RolloutPlan resources.",
"id": "RolloutPlansListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of RolloutPlan resources.",
"items": {
"$ref": "RolloutPlan"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RolloutRolloutEntity": {
"description": "Specifications of the resource to roll out.",
"id": "RolloutRolloutEntity",
"properties": {
"orchestratedEntity": {
"$ref": "RolloutRolloutEntityOrchestratedEntity",
"description": "Optional. Entity details for products using the Orchestrated Integration model."
}
},
"type": "object"
},
"RolloutRolloutEntityOrchestratedEntity": {
"description": "This message is used if the resource type follows the Orchestrated\nintegration model with ProgressiveRollout.",
"id": "RolloutRolloutEntityOrchestratedEntity",
"properties": {
"conflictBehavior": {
"description": "Required. Specifies the behavior of the Rollout if an out of band update is\ndetected in a project during a Rollout. It can be one of the following\nvalues:\n1) overwrite : Overwrite the local value with the rollout value.\n2) no_overwrite : Do not overwrite the local value with the rollout\nvalue.",
"type": "string"
},
"orchestrationAction": {
"description": "Required. Orchestration action during the Rollout. It can be one of the following\nvalues:\n1) \"update\": Resources will be updated by the rollout.\n2) \"delete\": Resources will be deleted by the rollout.",
"type": "string"
},
"orchestrationSource": {
"description": "Required. Fully qualified resource name of the resource which contains the source\nof truth of the configuration being rolled out across\nlocations/projects. For example, in the case of a global Rollout which\nis applied across regions, this contains the name of the global\nresource created by the user which contains a payload for a resource\nthat is orchestrated across regions. This follows the following format:\n//.googleapis.com/projects//locations/global//\ne.g.\n//osconfig.googleapis.com/projects/1/locations/global/policyOrchestrators/po1",
"type": "string"
}
},
"type": "object"
},
"RolloutWaveDetails": {
"description": "Additional metadata about the status of each wave provided by the server.",
"id": "RolloutWaveDetails",
"properties": {
"orchestratedWaveDetails": {
"$ref": "RolloutWaveDetailsOrchestratedWaveDetails",
"description": "Output only. Additional details of the wave for products using the Orchestrated\nIntegration model.",
"readOnly": true
},
"waveDisplayName": {
"description": "Output only. Wave name.\nEx. wave1",
"readOnly": true,
"type": "string"
},
"waveNumber": {
"description": "Output only. System generated number for the wave.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RolloutWaveDetailsOrchestratedWaveDetails": {
"description": "Details of the wave for products using the Orchestrated integration\nmodel.",
"id": "RolloutWaveDetailsOrchestratedWaveDetails",
"properties": {
"completedResourcesCount": {
"description": "Output only. Resource completed so far.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"estimatedCompletionTime": {
"description": "Output only. Estimated timestamp at which the wave will complete. Extrapolated from\ncurrent progress.",
"readOnly": true,
"type": "string"
},
"estimatedTotalResourcesCount": {
"description": "Output only. Estimated total count of resources.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"failedLocations": {
"description": "Output only. Locations that failed during orchestration, and ProgressiveRollout\nstopped retrying. There may be some successful resources rolled out in\nthe wave as the location may have failed later in the Rollout.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"failedResourcesCount": {
"description": "Output only. Resources failed.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"locationStatus": {
"additionalProperties": {
"$ref": "RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus"
},
"description": "Output only. Status of each location in the wave. Map keys (locations) must be\nspecified like \"us-east1\" or \"asia-west1-a\".",
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus": {
"description": "Represents the status of a location in a wave.",
"id": "RolloutWaveDetailsOrchestratedWaveDetailsLocationStatus",
"properties": {
"state": {
"description": "Output only. Location state of the wave.",
"enum": [
"STATE_FAILED",
"STATE_IN_PROGRESS",
"STATE_PENDING",
"STATE_SKIPPED",
"STATE_SUCCEEDED",
"STATE_UNSPECIFIED"
],
"enumDescriptions": [
"Work on the wave failed.",
"Work on the wave is in progress.",
"Work on the wave is pending.",
"Work on the wave was canceled or skipped.",
"Work on the wave succeeded.",
"Undefined default state. Should never be exposed to users."
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RolloutsListResponse": {
"id": "RolloutsListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of Rollout resources.",
"items": {
"$ref": "Rollout"
},
"type": "array"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"Route": {
"description": "Represents a Route resource.\n\nA route defines a path from VM instances in the VPC network to a specific\ndestination. This destination can be inside or outside the VPC network.\nFor more information, read theRoutes overview.",
"id": "Route",
"properties": {
"asPaths": {
"description": "Output only. [Output Only] AS path.",
"items": {
"$ref": "RouteAsPath"
},
"readOnly": true,
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this field when you\ncreate the resource.",
"type": "string"
},
"destRange": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "The destination range of outgoing packets that this route applies to. Both\nIPv4 and IPv6 are supported.\nMust specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291\nformat (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952\ncompressed format.",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#route",
"description": "Output only. [Output Only] Type of this resource. Always compute#routes for\nRoute resources.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a\nlowercase letter, and all following characters (except for the last\ncharacter) must be a dash, lowercase letter, or digit. The last character\nmust 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.\nYou can only specify the internet gateway using a full or\npartial valid URL: projects/project/global/gateways/default-internet-gateway",
"type": "string"
},
"nextHopHub": {
"description": "Output only. [Output Only] The full resource name of the Network Connectivity Center hub\nthat will handle matching packets.",
"readOnly": true,
"type": "string"
},
"nextHopIlb": {
"description": "The URL to a forwarding rule of typeloadBalancingScheme=INTERNAL that should handle matching\npackets or the IP address of the forwarding Rule.\nFor example, the following are all valid URLs:\n   \n   \n      - https://www.googleapis.com/compute/v1/projects/project/regions/region/forwardingRules/forwardingRule \n   - regions/region/forwardingRules/forwardingRule\n\n\nIf an IP address is provided, must specify an IPv4 address in dot-decimal\nnotation or an IPv6 address in RFC 4291 format. For example, the following\nare all valid IP addresses:\n   \n   \n      - 10.128.0.56\n      - 2001:db8::2d9:51:0:0\n      - 2001:db8:0:0:2d9:51:0:0\n\n\nIPv6 addresses will be displayed using RFC 5952 compressed format (e.g.\n2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.",
"type": "string"
},
"nextHopInstance": {
"description": "The URL to an instance that should handle matching packets. You can specify\nthis as a full or partial URL.\nFor example: \nhttps://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/",
"type": "string"
},
"nextHopInterRegionCost": {
"description": "Output only. [Output only] Internal fixed region-to-region cost that Google Cloud\ncalculates based on factors such as network performance, distance, and\navailable bandwidth between regions.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"nextHopInterconnectAttachment": {
"description": "Output only. [Output Only] The URL to an InterconnectAttachment which is the next hop\nfor the route.\nThis field will only be populated for dynamic routes generated by\nCloud Router with a linked interconnectAttachment or the static route\ngenerated by each L2 Interconnect Attachment.",
"readOnly": true,
"type": "string"
},
"nextHopIp": {
"description": "The network IP address of an instance that should handle matching packets.\nBoth IPv6 address and IPv4 addresses are supported.\nMust specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or\nan IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or\n2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952\ncompressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an\nIPv4-mapped IPv6 address.",
"type": "string"
},
"nextHopMed": {
"description": "Output only. [Output Only] Multi-Exit Discriminator, a BGP route metric that indicates\nthe desirability of a particular route in a network.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"nextHopNetwork": {
"description": "The URL of the local network if it should handle matching packets.",
"type": "string"
},
"nextHopOrigin": {
"description": "Output only. [Output Only] Indicates the origin of the route. Can be IGP\n(Interior Gateway Protocol), EGP (Exterior Gateway Protocol),\nor INCOMPLETE.",
"enum": [
"EGP",
"IGP",
"INCOMPLETE"
],
"enumDescriptions": [
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"nextHopPeering": {
"description": "Output only. [Output Only] The network peering name that should handle matching packets,\nwhich should conform to RFC1035.",
"readOnly": true,
"type": "string"
},
"nextHopVpnTunnel": {
"description": "The URL to a VpnTunnel that should handle matching packets.",
"type": "string"
},
"params": {
"$ref": "RouteParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"priority": {
"annotations": {
"required": [
"compute.routes.insert"
]
},
"description": "The priority of this route. Priority is used to break ties in cases\nwhere there is more than one matching route of equal prefix length. In\ncases where multiple routes have equal prefix length, the one with the\nlowest-numbered priority value wins. The default value is `1000`. The\npriority value must be from `0` to `65535`, inclusive.",
"format": "uint32",
"type": "integer"
},
"routeStatus": {
"description": "[Output only] The status of the route. This status applies to\ndynamic routes learned by Cloud Routers. It is also applicable to routes\nundergoing migration.",
"enum": [
"ACTIVE",
"DROPPED",
"INACTIVE",
"PENDING"
],
"enumDescriptions": [
"This route is processed and active.",
"The route is dropped due to the VPC exceeding the dynamic route limit.\n For dynamic route limit, please refer to the\nLearned route example",
"This route is processed but inactive due to failure from the backend. The\nbackend may have rejected the route",
"This route is being processed internally. The status will change once\nprocessed."
],
"type": "string"
},
"routeType": {
"description": "Output only. [Output Only] The type of this route, which can be one of the following\nvalues:\n- 'TRANSIT' for a transit route that this router learned from\nanother Cloud Router and will readvertise to one of its BGP peers \n- 'SUBNET' for a route from a subnet of the VPC \n- 'BGP' for a route learned from a BGP peer of this router \n- 'STATIC' for a static route",
"enum": [
"BGP",
"STATIC",
"SUBNET",
"TRANSIT"
],
"enumDescriptions": [
"",
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined fully-qualified URL for this resource.",
"type": "string"
},
"tags": {
"description": "A list of instance tags to which this route applies.",
"items": {
"type": "string"
},
"type": "array"
},
"warnings": {
"description": "Output only. [Output Only] If potential misconfigurations are detected for this\nroute, this field will be populated with warning messages.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"RouteAsPath": {
"id": "RouteAsPath",
"properties": {
"asLists": {
"description": "[Output Only] The AS numbers of the AS Path.",
"items": {
"format": "uint32",
"type": "integer"
},
"type": "array"
},
"pathSegmentType": {
"description": "[Output Only] The type of the AS Path, which can be one of the following\nvalues: \n- 'AS_SET': unordered set of autonomous systems that the route\nin has traversed  \n- 'AS_SEQUENCE': ordered set of autonomous\nsystems that the route has traversed  \n- 'AS_CONFED_SEQUENCE':\nordered set of Member Autonomous Systems in the local confederation that\nthe route has traversed  \n- 'AS_CONFED_SET': unordered set of\nMember Autonomous Systems in the local confederation that the route has\ntraversed",
"enum": [
"AS_CONFED_SEQUENCE",
"AS_CONFED_SET",
"AS_SEQUENCE",
"AS_SET"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RouteParams": {
"description": "Additional route parameters.",
"id": "RouteParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"RoutePolicy": {
"id": "RoutePolicy",
"properties": {
"description": {
"description": "An optional description of route policy.",
"type": "string"
},
"fingerprint": {
"description": "A fingerprint for the Route Policy being applied to this Router, which is\nessentially a hash of the Route Policy used for optimistic locking.\nThe fingerprint is initially generated by Compute Engine and changes\nafter every request to modify or update Route Policy. You must always\nprovide an up-to-date fingerprint hash in order to update or change\nlabels.\n\nTo see the latest fingerprint, make a getRoutePolicy() request\nto retrieve a Route Policy.",
"format": "byte",
"type": "string"
},
"name": {
"description": "Route Policy name, which must be a resource ID segment and unique\nwithin all the router's Route Policies. Name should conform to RFC1035.",
"type": "string"
},
"terms": {
"description": "List of terms (the order in the list is not important, they are evaluated\nin order of priority). Order of policies is not retained and might change\nwhen getting policy later.",
"items": {
"$ref": "RoutePolicyPolicyTerm"
},
"type": "array"
},
"type": {
"enum": [
"ROUTE_POLICY_TYPE_EXPORT",
"ROUTE_POLICY_TYPE_IMPORT"
],
"enumDescriptions": [
"The Route Policy is an Export Policy.",
"The Route Policy is an Import Policy."
],
"type": "string"
}
},
"type": "object"
},
"RoutePolicyPolicyTerm": {
"id": "RoutePolicyPolicyTerm",
"properties": {
"actions": {
"description": "CEL expressions to evaluate to modify a route when this term matches.",
"items": {
"$ref": "Expr"
},
"type": "array"
},
"match": {
"$ref": "Expr",
"description": "CEL expression evaluated against a route to determine if this term\napplies. When not set, the term applies to all\nroutes."
},
"priority": {
"description": "The evaluation priority for this term, which must be between 0\n(inclusive) and 2^31 (exclusive), and unique within the list.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"Router": {
"description": "Represents a Cloud Router resource.\n\nFor more information about Cloud Router, read theCloud\nRouter 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\nestablish BGP peering. This information must specify the peer ASN and\neither the interface name, IP address, or peer IP address. Please refer toRFC4273.",
"items": {
"$ref": "RouterBgpPeer"
},
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"encryptedInterconnectRouter": {
"description": "Indicates if a router is dedicated for use with encrypted VLAN\nattachments (interconnectAttachments).",
"type": "boolean"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"interfaces": {
"description": "Router interfaces.\nTo create a BGP peer that uses a router interface,\nthe interface must have one of the following fields specified:\n   \n   - linkedVpnTunnel\n   - linkedInterconnectAttachment\n   - subnetwork\n\n\nYou can create a router interface without any of these fields specified.\nHowever, you cannot create a BGP peer that uses that interface.",
"items": {
"$ref": "RouterInterface"
},
"type": "array"
},
"kind": {
"default": "compute#router",
"description": "Output only. [Output Only] Type of resource. Always compute#router for\nrouters.",
"readOnly": true,
"type": "string"
},
"md5AuthenticationKeys": {
"description": "Keys used for MD5 authentication.",
"items": {
"$ref": "RouterMd5AuthenticationKey"
},
"type": "array"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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"
},
"params": {
"$ref": "RouterParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "[Output Only] URI of the region where the router resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nThe options are DEFAULT or CUSTOM.",
"enum": [
"CUSTOM",
"DEFAULT"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"advertisedGroups": {
"description": "User-specified list of prefix groups to advertise in custom mode.\nThis field can only be populated if advertise_mode is CUSTOM and\nis advertised to all peers of the router.\nThese groups will be advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups.",
"items": {
"enum": [
"ALL_SUBNETS"
],
"enumDescriptions": [
"Advertise all available subnets (including peer VPC subnets)."
],
"type": "string"
},
"type": "array"
},
"advertisedIpRanges": {
"description": "User-specified list of individual IP ranges to advertise in custom mode.\nThis field can only be populated if advertise_mode is CUSTOM and\nis advertised to all peers of the router.\nThese IP ranges will be advertised in addition to any specified groups.\nLeave this field blank to advertise no custom IP ranges.",
"items": {
"$ref": "RouterAdvertisedIpRange"
},
"type": "array"
},
"asn": {
"description": "Local BGP Autonomous System Number (ASN).\nMust be anRFC6996 private ASN, either 16-bit or 32-bit. The\nvalue will be fixed for this router resource. All VPN tunnels that link\nto this router will have the same local ASN.",
"format": "uint32",
"type": "integer"
},
"identifierRange": {
"description": "Explicitly specifies a range of valid BGP Identifiers for this Router. It\nis provided as a link-local IPv4 range (from 169.254.0.0/16), of size at\nleast /30, even if the BGP sessions are over IPv6. It must not overlap\nwith any IPv4 BGP session ranges.\n\n\nOther vendors commonly call this \"router ID\".",
"type": "string"
},
"keepaliveInterval": {
"description": "The interval in seconds between BGP keepalive messages that are\nsent to the peer.\n\n\nHold time is three times the interval at which keepalive messages are\nsent, and the hold time is the maximum number of seconds allowed to\nelapse between successive keepalive messages that BGP receives from a\npeer.\n\n\nBGP will use the smaller of either the local hold time value or the\npeer's hold time value as the hold time for the BGP connection between\nthe two peers.\n\n\nIf set, this value must be between 20 and 60. The default is 20.",
"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,\nwhich currently supports the following option:\n   \n   - ALL_SUBNETS: Advertises all of the router's own VPC subnets. This\n   excludes any routes learned for subnets that use\n   VPC Network Peering.\n\n\nNote that this field can only be populated if advertise_mode is CUSTOM\nand overrides the list defined for the router (in the \"bgp\" message).\nThese groups are advertised in addition to any specified prefixes.\nLeave this field blank to advertise no custom groups.",
"items": {
"enum": [
"ALL_SUBNETS"
],
"enumDescriptions": [
"Advertise all available subnets (including peer VPC subnets)."
],
"type": "string"
},
"type": "array"
},
"advertisedIpRanges": {
"description": "User-specified list of individual IP ranges to advertise in custom mode.\nThis field can only be populated if advertise_mode is CUSTOM and\noverrides the list defined for the router (in the \"bgp\" message).\nThese IP ranges are advertised in addition to any specified groups.\nLeave 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\nthan one matching route of maximum length, the routes with the lowest\npriority value win.",
"format": "uint32",
"type": "integer"
},
"bfd": {
"$ref": "RouterBgpPeerBfd",
"description": "BFD configuration for the BGP peering."
},
"customLearnedIpRanges": {
"description": "A list of user-defined custom learned route IP address ranges for a BGP\nsession.",
"items": {
"$ref": "RouterBgpPeerCustomLearnedIpRange"
},
"type": "array"
},
"customLearnedRoutePriority": {
"description": "The user-defined custom learned route priority for a BGP session. This\nvalue is applied to all custom learned route ranges for the session.\nYou can choose a value from `0` to `65335`. If you don't provide a\nvalue, Google Cloud assigns a priority of `100` to the ranges.",
"format": "int32",
"type": "integer"
},
"enable": {
"description": "The status of the BGP peer connection.\n\n\nIf set to FALSE, any active session with the peer is terminated and\nall associated routing information is removed. If set to TRUE, the\npeer connection can be established with routing information. The default\nis TRUE.",
"enum": [
"FALSE",
"TRUE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"enableIpv4": {
"description": "Enable IPv4 traffic over BGP Peer. It is enabled by default if\nthe peerIpAddress is version 4.",
"type": "boolean"
},
"enableIpv6": {
"description": "Enable IPv6 traffic over BGP Peer. It is enabled by default if the\npeerIpAddress is version 6.",
"type": "boolean"
},
"exportPolicies": {
"description": "List of export policies applied to this peer, in the order they must be\nevaluated. The name must correspond to an existing policy that has\nROUTE_POLICY_TYPE_EXPORT type.",
"items": {
"type": "string"
},
"type": "array"
},
"importPolicies": {
"description": "List of import policies applied to this peer, in the order they must be\nevaluated. The name must correspond to an existing policy that has\nROUTE_POLICY_TYPE_IMPORT type.",
"items": {
"type": "string"
},
"type": "array"
},
"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.",
"type": "string"
},
"ipv4NexthopAddress": {
"description": "IPv4 address of the interface inside Google Cloud Platform.",
"type": "string"
},
"ipv6NexthopAddress": {
"description": "IPv6 address of the interface inside Google Cloud Platform.",
"type": "string"
},
"managementType": {
"description": "Output only. [Output Only] The resource that configures and manages this BGP peer.\n   \n   -  MANAGED_BY_USER is the default value and can be managed by you\n   or other users\n   - MANAGED_BY_ATTACHMENT is a BGP peer that is configured and managed\n   by Cloud Interconnect, specifically by an InterconnectAttachment of type\n   PARTNER. Google automatically creates, updates, and deletes this type of\n   BGP peer when the PARTNER InterconnectAttachment is created, updated,\n   or deleted.",
"enum": [
"MANAGED_BY_ATTACHMENT",
"MANAGED_BY_USER"
],
"enumDescriptions": [
"The BGP peer is automatically created for PARTNER type\nInterconnectAttachment; Google will automatically create/delete\nthis BGP peer when the PARTNER InterconnectAttachment is\ncreated/deleted, and Google will update the ipAddress and\npeerIpAddress when the PARTNER InterconnectAttachment is provisioned.\nThis type of BGP peer cannot be created or deleted, but can be\nmodified for all fields except for name, ipAddress and peerIpAddress.",
"Default value, the BGP peer is manually created and managed by user."
],
"readOnly": true,
"type": "string"
},
"md5AuthenticationKeyName": {
"description": "Present if MD5 authentication is enabled for the peering. Must be the\nname of one of the entries in the Router.md5_authentication_keys. The\nfield must comply with RFC1035.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of this BGP peer.\nThe name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash, lowercase\nletter, 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\na different value.",
"format": "uint32",
"type": "integer"
},
"peerIpAddress": {
"description": "IP address of the BGP interface outside Google Cloud Platform.",
"type": "string"
},
"peerIpv4NexthopAddress": {
"description": "IPv4 address of the BGP interface outside Google Cloud Platform.",
"type": "string"
},
"peerIpv6NexthopAddress": {
"description": "IPv6 address of the BGP interface outside Google Cloud Platform.",
"type": "string"
},
"routerApplianceInstance": {
"description": "URI of the VM instance that is used as third-party router\nappliances such as Next Gen Firewalls, Virtual Routers, or Router\nAppliances. The VM instance must be located in zones contained in the\nsame region as this Cloud Router.\nThe VM instance is the peer side of the BGP session.",
"type": "string"
}
},
"type": "object"
},
"RouterBgpPeerBfd": {
"id": "RouterBgpPeerBfd",
"properties": {
"minReceiveInterval": {
"description": "The minimum interval, in milliseconds, between BFD control packets\nreceived from the peer router. The actual value is negotiated between\nthe two routers and is equal to the greater of this value and the\ntransmit interval of the other router.\n\n\nIf set, this value must be between 1000 and 30000.\n\n\nThe default is 1000.",
"format": "uint32",
"type": "integer"
},
"minTransmitInterval": {
"description": "The minimum interval, in milliseconds, between BFD control packets\ntransmitted to the peer router. The actual value is negotiated between\nthe two routers and is equal to the greater of this value and the\ncorresponding receive interval of the other router.\n\n\nIf set, this value must be between 1000 and 30000.\n\n\nThe default is 1000.",
"format": "uint32",
"type": "integer"
},
"multiplier": {
"description": "The number of consecutive BFD packets that must be missed\nbefore BFD declares that a peer is unavailable.\n\n\nIf set, the value must be a value between 5 and 16.\n\n\nThe default is 5.",
"format": "uint32",
"type": "integer"
},
"sessionInitializationMode": {
"description": "The BFD session initialization mode for this BGP peer.\n\n\nIf set to ACTIVE, the Cloud Router will initiate the BFD session for\nthis BGP peer. If set to PASSIVE, the Cloud Router will wait for the\npeer router to initiate the BFD session for this BGP peer. If set to\nDISABLED, BFD is disabled for this BGP peer. The default is DISABLED.",
"enum": [
"ACTIVE",
"DISABLED",
"PASSIVE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"RouterBgpPeerCustomLearnedIpRange": {
"id": "RouterBgpPeerCustomLearnedIpRange",
"properties": {
"range": {
"description": "The custom learned route IP address range. Must be a valid\nCIDR-formatted prefix. If an IP address is provided without a subnet\nmask, it is interpreted as, for IPv4, a `/32` singular IP address\nrange, and, for IPv6, `/128`.",
"type": "string"
}
},
"type": "object"
},
"RouterInterface": {
"id": "RouterInterface",
"properties": {
"ipRange": {
"description": "IP address and range of the interface.\n   \n   - For Internet Protocol version 4 (IPv4), the IP range must be in theRFC3927 link-local IP address space. The value must\n   be a CIDR-formatted string, for example, 169.254.0.1/30.\n   Note: Do not truncate the IP address, as it represents the IP address of\n   the interface. \n   - For Internet Protocol version 6 (IPv6), the value\n   must be a unique local address (ULA) range from fdff:1::/64\n   with a mask length of 126 or less. This value should be a CIDR-formatted\n   string, for example, fdff:1::1/112. Within the router's\n   VPC, this IPv6 prefix will be reserved exclusively for this connection\n   and cannot be used for any other purpose.",
"type": "string"
},
"ipVersion": {
"description": "IP version of this interface.",
"enum": [
"IPV4",
"IPV6"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"linkedInterconnectAttachment": {
"description": "URI of the linked Interconnect attachment. It must be in the same region\nas the router. Each interface can have one linked resource, which can be\na VPN tunnel, an Interconnect attachment, or a subnetwork.",
"type": "string"
},
"linkedVpnTunnel": {
"description": "URI of the linked VPN tunnel, which must be in the same region as the\nrouter. Each interface can have one linked resource, which can be\na VPN tunnel, an Interconnect attachment, or a subnetwork.",
"type": "string"
},
"managementType": {
"description": "Output only. [Output Only] The resource that configures and manages this interface.\n   \n   - MANAGED_BY_USER is the default value and can be managed directly\n   by users.\n   - MANAGED_BY_ATTACHMENT is an interface that is configured and\n   managed by Cloud Interconnect, specifically, by an InterconnectAttachment\n   of type PARTNER. Google automatically creates, updates, and deletes\n   this type of interface when the PARTNER InterconnectAttachment is\n   created, updated, or deleted.",
"enum": [
"MANAGED_BY_ATTACHMENT",
"MANAGED_BY_USER"
],
"enumDescriptions": [
"The interface is automatically created for PARTNER type\nInterconnectAttachment, Google will automatically create/update/delete\nthis interface when the PARTNER InterconnectAttachment is\ncreated/provisioned/deleted.\nThis type of interface cannot be manually managed by user.",
"Default value, the interface is manually created and managed by user."
],
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "Name of this interface entry.\nThe name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash, lowercase\nletter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"privateIpAddress": {
"description": "The regional private internal IP address that is used to establish\nBGP sessions to a VM instance acting as a third-party\nRouter Appliance, such as a Next Gen Firewall, a Virtual Router, or\nan SD-WAN VM.",
"type": "string"
},
"redundantInterface": {
"description": "Name of the interface that will be redundant with the current interface\nyou are creating. The redundantInterface must belong to the same Cloud\nRouter as the interface here. To establish the BGP session to a Router\nAppliance VM, you must create two BGP peers. The two BGP peers must be\nattached to two separate interfaces that are redundant with each other.\nThe redundant_interface must be 1-63 characters long, and comply withRFC1035. Specifically, the redundant_interface must\nbe 1-63 characters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash, lowercase\nletter, or digit, except the last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"subnetwork": {
"description": "The URI of the subnetwork resource that this interface belongs to, which\nmust be in the same region as the Cloud Router.\nWhen you establish a BGP session to a VM instance using this interface,\nthe VM instance must belong to the same subnetwork as the subnetwork\nspecified here.",
"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. [Output Only] Type of resource. Always compute#router for\nrouters.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RouterMd5AuthenticationKey": {
"id": "RouterMd5AuthenticationKey",
"properties": {
"key": {
"annotations": {
"required": [
"compute.routers.insert"
]
},
"description": "[Input only] Value of the key.\n\nFor patch and update calls, it can be skipped to\ncopy the value from the previous configuration. This is allowed if the\nkey with the same name existed before the operation. Maximum length is 80\ncharacters. Can only contain printable ASCII characters.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.routers.insert",
"compute.routers.update"
]
},
"description": "Name used to identify the key.\n\nMust be unique within a router. Must be referenced by exactly\none bgpPeer. Must comply withRFC1035.",
"type": "string"
}
},
"type": "object"
},
"RouterNat": {
"description": "Represents a Nat resource. It enables the VMs within the specified\nsubnetworks to access Internet without external IP addresses. It specifies\na list of subnetworks (and the ranges within) that want to use NAT.\nCustomers can also provide the external IPs that would be used for NAT. GCP\nwould auto-allocate ephemeral IPs if no external IPs are provided.",
"id": "RouterNat",
"properties": {
"autoNetworkTier": {
"description": "The network tier to use when automatically reserving NAT IP addresses.\nMust be one of: PREMIUM, STANDARD.\nIf not specified, then the current \nproject-level default tier is used.",
"enum": [
"FIXED_STANDARD",
"PREMIUM",
"STANDARD",
"STANDARD_OVERRIDES_FIXED_STANDARD"
],
"enumDescriptions": [
"Public internet quality with fixed bandwidth.",
"High quality, Google-grade network tier, support for all networking\nproducts.",
"Public internet quality, only limited support for other networking\nproducts.",
"(Output only) Temporary tier for FIXED_STANDARD when fixed standard tier\nis expired or not configured."
],
"type": "string"
},
"drainNatIps": {
"description": "A list of URLs of the IP resources to be drained. These IPs\nmust be valid static external IPs that have been assigned to the NAT.\nThese IPs should be used for updating/patching a NAT only.",
"items": {
"type": "string"
},
"type": "array"
},
"enableDynamicPortAllocation": {
"description": "Enable Dynamic Port Allocation.\n\n\nIf not specified, it is disabled by default.\n\n\nIf set to true,\n   \n   - Dynamic Port Allocation will be enabled on this NAT\n   config.\n   - enableEndpointIndependentMapping cannot be set to true.\n   - If minPorts is set, minPortsPerVm must be set to a\n   power of two greater than or equal to 32. If minPortsPerVm is not set, a\n   minimum of 32 ports will be allocated to a VM from this NAT\n   config.",
"type": "boolean"
},
"enableEndpointIndependentMapping": {
"type": "boolean"
},
"endpointTypes": {
"description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list\nis empty, then it will be equivalent to include ENDPOINT_TYPE_VM",
"items": {
"enum": [
"ENDPOINT_TYPE_MANAGED_PROXY_LB",
"ENDPOINT_TYPE_SWG",
"ENDPOINT_TYPE_VM"
],
"enumDescriptions": [
"This is used for regional Application Load Balancers (internal and\nexternal) and regional proxy Network Load Balancers (internal and\nexternal) endpoints.",
"This is used for Secure Web Gateway endpoints.",
"This is the default."
],
"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."
},
"maxPortsPerVm": {
"description": "Maximum number of ports allocated to a VM from this NAT config when\nDynamic Port Allocation is enabled.\n\n\nIf Dynamic Port Allocation is not enabled, this field has no effect.\n\n\nIf Dynamic Port Allocation is enabled, and this field is set, it must be\nset to a power of two greater than minPortsPerVm, or 64 if minPortsPerVm\nis not set.\n\n\nIf Dynamic Port Allocation is enabled and this field is not set,\na maximum of 65536 ports will be allocated to a VM from this NAT\nconfig.",
"format": "int32",
"type": "integer"
},
"minPortsPerVm": {
"description": "Minimum number of ports allocated to a VM from this NAT config. If not\nset, a default number of ports is allocated to a VM. This is rounded\nup to the nearest power of 2. For example, if the value of this field is\n50, at least 64 ports are allocated to a VM.",
"format": "int32",
"type": "integer"
},
"name": {
"description": "Unique name of this Nat service.\nThe name must be 1-63 characters long and comply withRFC1035.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"nat64Subnetworks": {
"description": "List of Subnetwork resources whose traffic should be translated by NAT64\nGateway. It is used only when LIST_OF_IPV6_SUBNETWORKS is\nselected for the SubnetworkIpRangeToNat64Option above.",
"items": {
"$ref": "RouterNatSubnetworkToNat64"
},
"type": "array"
},
"natIpAllocateOption": {
"description": "Specify the NatIpAllocateOption, which can take one of the following\nvalues: \n   \n   - MANUAL_ONLY: Uses only Nat IP addresses provided by\n   customers. When there are not enough specified Nat IPs, the Nat service\n   fails for new VMs.\n   - AUTO_ONLY: Nat IPs are allocated by Google Cloud Platform; customers\n   can't specify any Nat IPs. When choosing AUTO_ONLY, then nat_ip should\n   be empty.",
"enum": [
"AUTO_ONLY",
"MANUAL_ONLY"
],
"enumDescriptions": [
"Nat IPs are allocated by GCP; customers can not specify any Nat IPs.",
"Only use Nat IPs provided by customers. When specified Nat IPs are not\nenough then the Nat service fails for new VMs."
],
"type": "string"
},
"natIps": {
"description": "A list of URLs of the IP resources used for this Nat service. These IP\naddresses must be valid static external IP addresses assigned to the\nproject.",
"items": {
"type": "string"
},
"type": "array"
},
"rules": {
"description": "A list of rules associated with this NAT.",
"items": {
"$ref": "RouterNatRule"
},
"type": "array"
},
"sourceSubnetworkIpRangesToNat": {
"description": "Specify the Nat option, which can take one of the following values:\n   \n   - ALL_SUBNETWORKS_ALL_IP_RANGES: All of the IP ranges in every\n   Subnetwork are allowed to Nat.\n   - ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES: All of the primary IP ranges\n   in every Subnetwork are allowed to Nat.\n   - LIST_OF_SUBNETWORKS: A list of Subnetworks are allowed to Nat\n   (specified in the field subnetwork below)\n\n\nThe default is SUBNETWORK_IP_RANGE_TO_NAT_OPTION_UNSPECIFIED.\nNote that if this field contains ALL_SUBNETWORKS_ALL_IP_RANGES then there\nshould not be any other Router.Nat section in any Router for this network\nin this region.",
"enum": [
"ALL_SUBNETWORKS_ALL_IP_RANGES",
"ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES",
"LIST_OF_SUBNETWORKS"
],
"enumDescriptions": [
"All the IP ranges in every Subnetwork are allowed to Nat.",
"All the primary IP ranges in every Subnetwork are allowed to Nat.",
"A list of Subnetworks are allowed to Nat (specified in the field\nsubnetwork below)"
],
"type": "string"
},
"sourceSubnetworkIpRangesToNat64": {
"description": "Specify the Nat option for NAT64, which can take one of the following\nvalues: \n   \n   - ALL_IPV6_SUBNETWORKS: All of the IP ranges in\n   every Subnetwork are allowed to Nat.\n   - LIST_OF_IPV6_SUBNETWORKS: A list of Subnetworks are allowed to Nat\n   (specified in the field nat64_subnetwork below)\n\n\nThe default is NAT64_OPTION_UNSPECIFIED.\nNote that if this field contains NAT64_ALL_V6_SUBNETWORKS no other\nRouter.Nat section in this region can also enable NAT64 for any\nSubnetworks in this network. Other Router.Nat sections can still be\npresent to enable NAT44 only.",
"enum": [
"ALL_IPV6_SUBNETWORKS",
"LIST_OF_IPV6_SUBNETWORKS"
],
"enumDescriptions": [
"NAT64 is enabled for all the IPv6 subnet ranges.\nIn dual stack subnets, NAT64 will only be enabled for IPv6-only VMs.",
"NAT64 is enabled for a list of IPv6 subnet ranges.\nIn dual stack subnets, NAT64 will only be enabled for IPv6-only VMs.\nIf this option is used, the nat64_subnetworks field must be specified."
],
"type": "string"
},
"subnetworks": {
"description": "A list of Subnetwork resources whose traffic should be translated by NAT\nGateway. It is used only when LIST_OF_SUBNETWORKS is selected for the\nSubnetworkIpRangeToNatOption above.",
"items": {
"$ref": "RouterNatSubnetworkToNat"
},
"type": "array"
},
"tcpEstablishedIdleTimeoutSec": {
"description": "Timeout (in seconds) for TCP established connections. Defaults to 1200s\nif not set.",
"format": "int32",
"type": "integer"
},
"tcpTimeWaitTimeoutSec": {
"description": "Timeout (in seconds) for TCP connections that are in TIME_WAIT state.\nDefaults to 120s if not set.",
"format": "int32",
"type": "integer"
},
"tcpTransitoryIdleTimeoutSec": {
"description": "Timeout (in seconds) for TCP transitory connections. Defaults to 30s if\nnot set.",
"format": "int32",
"type": "integer"
},
"type": {
"description": "Indicates whether this NAT is used for public or private IP\ntranslation. If unspecified, it defaults to PUBLIC.",
"enum": [
"PRIVATE",
"PUBLIC"
],
"enumDescriptions": [
"NAT used for private IP translation.",
"NAT used for public IP translation.\nThis is the default."
],
"type": "string"
},
"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,\nlogs are exported for all connections handled by this NAT.\nThis option can take one of the following values:\n   \n   - ERRORS_ONLY: Export logs only for connection failures.\n   - TRANSLATIONS_ONLY: Export logs only for successful\n   connections.\n   - ALL: Export logs for all connections, successful and\n   unsuccessful.",
"enum": [
"ALL",
"ERRORS_ONLY",
"TRANSLATIONS_ONLY"
],
"enumDescriptions": [
"Export logs for all (successful and unsuccessful) connections.",
"Export logs for connection failures only.",
"Export logs for successful connections only."
],
"type": "string"
}
},
"type": "object"
},
"RouterNatRule": {
"id": "RouterNatRule",
"properties": {
"action": {
"$ref": "RouterNatRuleAction",
"description": "The action to be enforced for traffic that matches this rule."
},
"description": {
"description": "An optional description of this rule.",
"type": "string"
},
"match": {
"description": "CEL expression that specifies the match condition that egress traffic\nfrom a VM is evaluated against. If it evaluates to true, the\ncorresponding `action` is enforced.\n\nThe following examples are valid match expressions for public NAT:\n\n`inIpRange(destination.ip, '1.1.0.0/16') || inIpRange(destination.ip,\n     '2.2.0.0/16')`\n\n`destination.ip == '1.1.0.1' || destination.ip == '8.8.8.8'`\n\nThe following example is a valid match expression for private NAT:\n\n`nexthop.hub ==\n'//networkconnectivity.googleapis.com/projects/my-project/locations/global/hubs/hub-1'`",
"type": "string"
},
"ruleNumber": {
"description": "An integer uniquely identifying a rule in the list. The rule number\nmust be a positive value between 0 and 65000, and\nmust be unique among rules within a NAT.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"RouterNatRuleAction": {
"id": "RouterNatRuleAction",
"properties": {
"sourceNatActiveIps": {
"description": "A list of URLs of the IP resources used for this NAT rule. These IP\naddresses must be valid static external IP addresses assigned to the\nproject.\nThis field is used for public NAT.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceNatActiveRanges": {
"description": "A list of URLs of the subnetworks used as source ranges for this\nNAT Rule. These subnetworks must have purpose set to PRIVATE_NAT.\nThis field is used for private NAT.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceNatDrainIps": {
"description": "A list of URLs of the IP resources to be drained. These IPs\nmust be valid static external IPs that have been assigned to the NAT.\nThese IPs should be used for updating/patching a NAT rule only.\nThis field is used for public NAT.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceNatDrainRanges": {
"description": "A list of URLs of subnetworks representing source ranges to be\ndrained. This is only supported on patch/update, and these\nsubnetworks must have previously been used as active ranges in this\nNAT Rule.\nThis field is used for private NAT.",
"items": {
"type": "string"
},
"type": "array"
}
},
"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\nuse NAT. This can be populated only if \"LIST_OF_SECONDARY_IP_RANGES\"\nis 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\noptions of a single value are valid except\nNAT_IP_RANGE_OPTION_UNSPECIFIED.\nThe only valid option with multiple values is: [\"PRIMARY_IP_RANGE\",\n\"LIST_OF_SECONDARY_IP_RANGES\"]\nDefault: [ALL_IP_RANGES]",
"items": {
"enum": [
"ALL_IP_RANGES",
"LIST_OF_SECONDARY_IP_RANGES",
"PRIMARY_IP_RANGE"
],
"enumDescriptions": [
"The primary and all the secondary ranges are allowed to Nat.",
"A list of secondary ranges are allowed to Nat.",
"The primary range is allowed to Nat."
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"RouterNatSubnetworkToNat64": {
"description": "Specifies a subnetwork to enable NAT64.",
"id": "RouterNatSubnetworkToNat64",
"properties": {
"name": {
"description": "URL for the subnetwork resource that will use NAT64.",
"type": "string"
}
},
"type": "object"
},
"RouterParams": {
"description": "Additional router parameters.",
"id": "RouterParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nThe field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"RouterStatus": {
"id": "RouterStatus",
"properties": {
"bestRoutes": {
"description": "A list of the best dynamic routes for this Cloud Router's Virtual Private\nCloud (VPC) network in the same region as this Cloud Router.\n\nLists all of the best routes per prefix that are programmed into this\nregion's VPC data plane.\n\nWhen global dynamic routing mode is turned on in the VPC network, this list\ncan include cross-region dynamic routes from Cloud Routers in other\nregions.",
"items": {
"$ref": "Route"
},
"type": "array"
},
"bestRoutesForRouter": {
"description": "A list of the best BGP routes learned by this Cloud Router.\n\nIt is possible that routes listed might not be programmed into the data\nplane, if the Google Cloud control plane finds a more optimal route for a\nprefix than a route learned by this Cloud 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"
},
"bfdStatus": {
"$ref": "BfdStatus"
},
"enableIpv4": {
"description": "Output only. Enable IPv4 traffic over BGP Peer.\nIt is enabled by default if the peerIpAddress is version 4.",
"readOnly": true,
"type": "boolean"
},
"enableIpv6": {
"description": "Output only. Enable IPv6 traffic over BGP Peer.\nIt is enabled by default if the peerIpAddress is version 6.",
"readOnly": true,
"type": "boolean"
},
"ipAddress": {
"description": "Output only. IP address of the local BGP interface.",
"readOnly": true,
"type": "string"
},
"ipv4NexthopAddress": {
"description": "Output only. IPv4 address of the local BGP interface.",
"readOnly": true,
"type": "string"
},
"ipv6NexthopAddress": {
"description": "Output only. IPv6 address of the local BGP interface.",
"readOnly": true,
"type": "string"
},
"linkedVpnTunnel": {
"description": "Output only. URL of the VPN tunnel that this BGP peer controls.",
"readOnly": true,
"type": "string"
},
"md5AuthEnabled": {
"description": "Informs whether MD5 authentication is enabled on this BGP peer.",
"type": "boolean"
},
"name": {
"description": "Output only. Name of this BGP peer. Unique within the Routers resource.",
"readOnly": true,
"type": "string"
},
"numLearnedRoutes": {
"description": "Output only. Number of routes learned from the remote BGP Peer.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"peerIpAddress": {
"description": "Output only. IP address of the remote BGP interface.",
"readOnly": true,
"type": "string"
},
"peerIpv4NexthopAddress": {
"description": "Output only. IPv4 address of the remote BGP interface.",
"readOnly": true,
"type": "string"
},
"peerIpv6NexthopAddress": {
"description": "Output only. IPv6 address of the remote BGP interface.",
"readOnly": true,
"type": "string"
},
"routerApplianceInstance": {
"description": "Output only. [Output only] URI of the VM instance that is used as third-party router\nappliances such as Next Gen Firewalls, Virtual Routers, or Router\nAppliances.\nThe VM instance is the peer side of the BGP session.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The state of the BGP session. For a list of possible values for this\nfield, seeBGP session states.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. Status of the BGP peer: {UP, DOWN}",
"enum": [
"DOWN",
"UNKNOWN",
"UP"
],
"enumDescriptions": [
"",
"",
""
],
"readOnly": true,
"type": "string"
},
"statusReason": {
"description": "Indicates why particular status was returned.",
"enum": [
"IPV4_PEER_ON_IPV6_ONLY_CONNECTION",
"IPV6_PEER_ON_IPV4_ONLY_CONNECTION",
"MD5_AUTH_INTERNAL_PROBLEM",
"STATUS_REASON_UNSPECIFIED"
],
"enumDescriptions": [
"BGP peer disabled because it requires IPv4 but the underlying\nconnection is IPv6-only.",
"BGP peer disabled because it requires IPv6 but the underlying\nconnection is IPv4-only.",
"Indicates internal problems with configuration of MD5 authentication.\nThis particular reason can only be returned when md5AuthEnabled is true\nand status is DOWN.",
""
],
"type": "string"
},
"uptime": {
"description": "Output only. Time this session has been up.\nFormat:\n 14 years, 51 weeks, 6 days, 23 hours, 59 minutes, 59 seconds",
"readOnly": true,
"type": "string"
},
"uptimeSeconds": {
"description": "Output only. Time this session has been up, in seconds.\nFormat:\n 145",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"RouterStatusNatStatus": {
"description": "Status of a NAT contained in this router.",
"id": "RouterStatusNatStatus",
"properties": {
"autoAllocatedNatIps": {
"description": "Output only. A list of IPs auto-allocated for NAT. Example: [\"1.1.1.1\", \"129.2.16.89\"]",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"drainAutoAllocatedNatIps": {
"description": "Output only. A list of IPs auto-allocated for NAT that are in drain mode.\nExample: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"drainUserAllocatedNatIps": {
"description": "Output only. A list of IPs user-allocated for NAT that are in drain mode.\nExample: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"minExtraNatIpsNeeded": {
"description": "Output only. The number of extra IPs to allocate. This will be greater than 0 only if\nuser-specified IPs are NOT enough to allow all configured VMs to use NAT.\nThis value is meaningful only when auto-allocation of NAT IPs is *not*\nused.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"name": {
"description": "Output only. Unique name of this NAT.",
"readOnly": true,
"type": "string"
},
"numVmEndpointsWithNatMappings": {
"description": "Output only. Number of VM endpoints (i.e., Nics) that can use NAT.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"ruleStatus": {
"description": "Status of rules in this NAT.",
"items": {
"$ref": "RouterStatusNatStatusNatRuleStatus"
},
"type": "array"
},
"userAllocatedNatIpResources": {
"description": "Output only. A list of fully qualified URLs of reserved IP address resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"userAllocatedNatIps": {
"description": "Output only. A list of IPs user-allocated for NAT.\nThey will be raw IP strings like \"179.12.26.133\".",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"RouterStatusNatStatusNatRuleStatus": {
"description": "Status of a NAT Rule contained in this NAT.",
"id": "RouterStatusNatStatusNatRuleStatus",
"properties": {
"activeNatIps": {
"description": "Output only. A list of active IPs for NAT.\nExample: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"drainNatIps": {
"description": "Output only. A list of IPs for NAT that are in drain mode.\nExample: [\"1.1.1.1\", \"179.12.26.133\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"minExtraIpsNeeded": {
"description": "Output only. The number of extra IPs to allocate. This will be greater than 0 only\nif the existing IPs in this NAT Rule are NOT enough to allow all\nconfigured VMs to use NAT.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"numVmEndpointsWithNatMappings": {
"description": "Output only. Number of VM endpoints (i.e., NICs) that have NAT Mappings from this\nNAT Rule.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"ruleNumber": {
"description": "Output only. Rule number of the rule.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"RouterStatusResponse": {
"id": "RouterStatusResponse",
"properties": {
"kind": {
"default": "compute#routerStatusResponse",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"result": {
"$ref": "RouterStatus"
}
},
"type": "object"
},
"RoutersGetRoutePolicyResponse": {
"id": "RoutersGetRoutePolicyResponse",
"properties": {
"resource": {
"$ref": "RoutePolicy"
}
},
"type": "object"
},
"RoutersListBgpRoutes": {
"id": "RoutersListBgpRoutes",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"type": "string"
},
"kind": {
"default": "compute#routersListBgpRoutes",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#routersListBgpRoutes for lists of bgp routes.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"result": {
"description": "[Output Only] A list of bgp routes.",
"items": {
"$ref": "BgpRoute"
},
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"RoutersListRoutePolicies": {
"id": "RoutersListRoutePolicies",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"type": "string"
},
"kind": {
"default": "compute#routersListRoutePolicies",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#routersListRoutePolicies for lists of route policies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"result": {
"description": "[Output Only] A list of route policies.",
"items": {
"$ref": "RoutePolicy"
},
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SSLHealthCheck": {
"id": "SSLHealthCheck",
"properties": {
"port": {
"description": "The TCP port number to which the health check prober sends packets. The\ndefault value is 443. Valid values are 1 through65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \n USE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"request": {
"description": "Instructs the health check prober to send this exact ASCII string, up to\n1024 bytes in length, after establishing the TCP connection and SSL\nhandshake.",
"type": "string"
},
"response": {
"description": "Creates a content-based SSL health check. In addition to establishing a\nTCP connection and the TLS handshake, you can configure the health check to\npass only when the backend sends this exact response ASCII string, up to\n1024 bytes in length. For details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp",
"type": "string"
}
},
"type": "object"
},
"SavedAttachedDisk": {
"description": "DEPRECATED: Please use compute#savedDisk instead.\nAn instance-attached disk resource.",
"id": "SavedAttachedDisk",
"properties": {
"autoDelete": {
"description": "Specifies whether the disk will be auto-deleted when the instance is\ndeleted (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\npartition of the disk for its root filesystem.",
"type": "boolean"
},
"deviceName": {
"description": "Specifies the name of the disk attached to the source instance.",
"type": "string"
},
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The encryption key for the disk."
},
"diskSizeGb": {
"description": "The size of the disk in base-2 GB.",
"format": "int64",
"type": "string"
},
"diskType": {
"description": "Output only. [Output Only] URL of the disk type resource. For example:projects/project/zones/zone/diskTypes/pd-standard or\npd-ssd",
"readOnly": true,
"type": "string"
},
"guestOsFeatures": {
"description": "A list of features to enable on the guest operating system. Applicable only\nfor bootable images. Read\nEnabling guest operating system features to see a list of available\noptions.",
"items": {
"$ref": "GuestOsFeature"
},
"type": "array"
},
"index": {
"description": "Output only. Specifies zero-based index of the disk that is attached to the source\ninstance.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"interface": {
"description": "Specifies the disk interface to use for attaching this disk, which is\neither SCSI or NVME.",
"enum": [
"NVME",
"SCSI"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"kind": {
"default": "compute#savedAttachedDisk",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.",
"readOnly": true,
"type": "string"
},
"licenses": {
"description": "Output only. [Output Only] Any valid publicly visible licenses.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"mode": {
"description": "The mode in which this disk is attached to the source instance, eitherREAD_WRITE or READ_ONLY.",
"enum": [
"READ_ONLY",
"READ_WRITE"
],
"enumDescriptions": [
"Attaches this disk in read-only mode. Multiple virtual machines can use\na disk in read-only mode at a time.",
"*[Default]* Attaches this disk in read-write mode. Only one\nvirtual machine at a time can be attached to a disk in read-write mode."
],
"type": "string"
},
"source": {
"description": "Specifies a URL of the disk attached to the source instance.",
"type": "string"
},
"storageBytes": {
"description": "Output only. [Output Only] A size of the storage used by the disk's snapshot by this\nmachine image.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"storageBytesStatus": {
"description": "Output only. [Output Only] An indicator whether storageBytes is in a\nstable state or it is being adjusted as a result of shared storage\nreallocation. This status can either be UPDATING, meaning\nthe size of the snapshot is being updated, or UP_TO_DATE,\nmeaning the size of the snapshot is up-to-date.",
"enum": [
"UPDATING",
"UP_TO_DATE"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "Specifies the type of the attached disk, either SCRATCH orPERSISTENT.",
"enum": [
"PERSISTENT",
"SCRATCH"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SavedDisk": {
"description": "An instance-attached disk resource.",
"id": "SavedDisk",
"properties": {
"architecture": {
"description": "Output only. [Output Only] The architecture of the attached disk.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#savedDisk",
"description": "Output only. [Output Only] Type of the resource. Always compute#savedDisk\nfor attached disks.",
"readOnly": true,
"type": "string"
},
"sourceDisk": {
"description": "Output only. Specifies a URL of the disk attached to the source instance.",
"readOnly": true,
"type": "string"
},
"storageBytes": {
"description": "Output only. [Output Only] Size of the individual disk snapshot used by this machine\nimage.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"storageBytesStatus": {
"description": "Output only. [Output Only] An indicator whether storageBytes is in a\nstable state or it is being adjusted as a result of shared storage\nreallocation. This status can either be UPDATING, meaning\nthe size of the snapshot is being updated, or UP_TO_DATE,\nmeaning the size of the snapshot is up-to-date.",
"enum": [
"UPDATING",
"UP_TO_DATE"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ScalingScheduleStatus": {
"id": "ScalingScheduleStatus",
"properties": {
"lastStartTime": {
"description": "[Output Only] The last time the scaling schedule became active.\nNote: this is a timestamp when a schedule actually became active, not when\nit was planned to do so.\nThe timestamp is in RFC3339\ntext format.",
"type": "string"
},
"nextStartTime": {
"description": "[Output Only] The next time the scaling schedule is to become active.\nNote: this is a timestamp when a schedule is planned to run, but the actual\ntime might be slightly different.\nThe timestamp is in RFC3339\ntext format.",
"type": "string"
},
"state": {
"description": "[Output Only] The current state of a scaling schedule.",
"enum": [
"ACTIVE",
"DISABLED",
"OBSOLETE",
"READY"
],
"enumDescriptions": [
"The current autoscaling recommendation is influenced by this scaling\nschedule.",
"This scaling schedule has been disabled by the user.",
"This scaling schedule will never become active again.",
"The current autoscaling recommendation is not influenced by this scaling\nschedule."
],
"type": "string"
}
},
"type": "object"
},
"Scheduling": {
"description": "Sets the scheduling options for an Instance.",
"id": "Scheduling",
"properties": {
"automaticRestart": {
"description": "Specifies whether the instance should be automatically restarted if it is\nterminated by Compute Engine (not terminated by a user). You can only set\nthe automatic restart option for standard instances.Preemptible instances\ncannot be automatically restarted.\n\nBy default, this is set to true so an instance is\nautomatically restarted if it is terminated by Compute Engine.",
"type": "boolean"
},
"availabilityDomain": {
"description": "Specifies the availability domain to place the instance in. The value\nmust be a number between 1 and the number of availability domains\nspecified in the spread placement policy attached to the instance.",
"format": "int32",
"type": "integer"
},
"hostErrorTimeoutSeconds": {
"description": "Specify the time in seconds for host error detection, the value must be\nwithin the range of [90, 330] with the increment of 30, if unset, the\ndefault behavior of host error recovery will be used.",
"format": "int32",
"type": "integer"
},
"instanceTerminationAction": {
"description": "Specifies the termination action for the instance.",
"enum": [
"DELETE",
"INSTANCE_TERMINATION_ACTION_UNSPECIFIED",
"STOP"
],
"enumDescriptions": [
"Delete the VM.",
"Default value. This value is unused.",
"Stop the VM without storing in-memory content. default action."
],
"type": "string"
},
"localSsdRecoveryTimeout": {
"$ref": "Duration",
"description": "Specifies the maximum amount of time a Local Ssd Vm should wait while\nrecovery of the Local Ssd state is attempted. Its value should be in\nbetween 0 and 168 hours with hour granularity and the default value being 1\nhour."
},
"locationHint": {
"description": "An opaque location hint used to place the instance close to other\nresources.\nThis field is for use by internal tools that use the public API.",
"type": "string"
},
"maxRunDuration": {
"$ref": "Duration",
"description": "Specifies the max run duration for the given instance. If specified,\nthe instance termination action will be performed at the end of the run\nduration."
},
"minNodeCpus": {
"description": "The minimum number of virtual CPUs this instance will consume when running\non a sole-tenant node.",
"format": "int32",
"type": "integer"
},
"nodeAffinities": {
"description": "A set of node affinity and anti-affinity configurations. Refer toConfiguring node\naffinity for more information.\nOverrides reservationAffinity.",
"items": {
"$ref": "SchedulingNodeAffinity"
},
"type": "array"
},
"onHostMaintenance": {
"description": "Defines the maintenance behavior for this instance. For standard instances,\nthe default behavior is MIGRATE. Forpreemptible instances,\nthe default and only possible behavior is TERMINATE. For more\ninformation, see\n Set\n VM host maintenance policy.",
"enum": [
"MIGRATE",
"TERMINATE"
],
"enumDescriptions": [
"*[Default]* Allows Compute Engine to automatically migrate instances\nout of the way of maintenance events.",
"Tells Compute Engine to terminate and (optionally) restart the instance\naway from the maintenance activity. If you would like your instance to be\nrestarted, set the automaticRestart flag to true. Your\ninstance may be restarted more than once, and it may be restarted outside\nthe window of maintenance events."
],
"type": "string"
},
"onInstanceStopAction": {
"$ref": "SchedulingOnInstanceStopAction"
},
"preemptible": {
"description": "Defines whether the instance is preemptible. This can only be set during\ninstance creation or while the instance isstopped and\ntherefore, in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.",
"type": "boolean"
},
"provisioningModel": {
"description": "Specifies the provisioning model of the instance.",
"enum": [
"FLEX_START",
"RESERVATION_BOUND",
"SPOT",
"STANDARD"
],
"enumDescriptions": [
"Instance is provisioned using the Flex Start provisioning model and\nhas a limited runtime.",
"Bound to the lifecycle of the reservation in which it is provisioned.",
"Heavily discounted, no guaranteed runtime.",
"Standard provisioning with user controlled runtime, no discounts."
],
"type": "string"
},
"skipGuestOsShutdown": {
"description": "Default is false and there will be 120 seconds between GCE ACPI G2 Soft\nOff and ACPI G3 Mechanical\nOff for Standard VMs and 30 seconds for Spot VMs.",
"type": "boolean"
},
"terminationTime": {
"description": "Specifies the timestamp, when the instance will be terminated, inRFC3339 text format. If specified, the instance\ntermination action will be performed at the termination time.",
"type": "string"
}
},
"type": "object"
},
"SchedulingNodeAffinity": {
"description": "Node Affinity: the configuration of desired nodes onto which this Instance\n 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 areIN for affinity and NOT_IN for anti-affinity.",
"enum": [
"IN",
"NOT_IN",
"OPERATOR_UNSPECIFIED"
],
"enumDescriptions": [
"Requires Compute Engine to seek for matched nodes.",
"Requires Compute Engine to avoid certain nodes.",
""
],
"type": "string"
},
"values": {
"description": "Corresponds to the label values of Node resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SchedulingOnInstanceStopAction": {
"description": "Defines the behaviour for instances with the instance_termination_actionSTOP.",
"id": "SchedulingOnInstanceStopAction",
"properties": {
"discardLocalSsd": {
"description": "If true, the contents of any attached Local SSD disks will be discarded\nelse, the Local SSD data will be preserved when the instance is stopped\nat the end of the run duration/termination time.",
"type": "boolean"
}
},
"type": "object"
},
"Screenshot": {
"description": "An instance's screenshot.",
"id": "Screenshot",
"properties": {
"contents": {
"description": "[Output Only] The Base64-encoded screenshot data.",
"type": "string"
},
"kind": {
"default": "compute#screenshot",
"description": "Output only. [Output Only] Type of the resource. Always compute#screenshot\nfor the screenshots.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SecurityPoliciesAggregatedList": {
"id": "SecurityPoliciesAggregatedList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "SecurityPoliciesScopedList",
"description": "Name of the scope containing this set of security policies."
},
"description": "A list of SecurityPoliciesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#securityPoliciesAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#securityPolicyAggregatedList for lists of Security\nPolicies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SecurityPoliciesListPreconfiguredExpressionSetsResponse": {
"id": "SecurityPoliciesListPreconfiguredExpressionSetsResponse",
"properties": {
"preconfiguredExpressionSets": {
"$ref": "SecurityPoliciesWafConfig"
}
},
"type": "object"
},
"SecurityPoliciesScopedList": {
"id": "SecurityPoliciesScopedList",
"properties": {
"securityPolicies": {
"description": "A list of SecurityPolicies contained in this scope.",
"items": {
"$ref": "SecurityPolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nsecurity policies when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SecurityPoliciesWafConfig": {
"id": "SecurityPoliciesWafConfig",
"properties": {
"wafRules": {
"$ref": "PreconfiguredWafSet"
}
},
"type": "object"
},
"SecurityPolicy": {
"description": "Represents a Google Cloud Armor security policy resource.\n\nOnly external backend services that use load balancers can\nreference a security policy. For more information, see\nGoogle Cloud Armor security policy overview.",
"id": "SecurityPolicy",
"properties": {
"adaptiveProtectionConfig": {
"$ref": "SecurityPolicyAdaptiveProtectionConfig"
},
"advancedOptionsConfig": {
"$ref": "SecurityPolicyAdvancedOptionsConfig"
},
"associations": {
"description": "A list of associations that belong to this policy.",
"items": {
"$ref": "SecurityPolicyAssociation"
},
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"ddosProtectionConfig": {
"$ref": "SecurityPolicyDdosProtectionConfig"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Specifies a fingerprint for this resource, which is essentially a hash of\nthe metadata's contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update metadata. You must always provide an\nup-to-date fingerprint hash in order to update or change metadata,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make get() request to the\nsecurity policy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#securityPolicy",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyfor security policies",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this security policy, which\nis essentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels.\n\nTo see the latest fingerprint, make get() request to the\nsecurity policy.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"parent": {
"description": "Output only. [Output Only] The parent of the security policy.",
"readOnly": true,
"type": "string"
},
"recaptchaOptionsConfig": {
"$ref": "SecurityPolicyRecaptchaOptionsConfig"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional security policy\nresides. This field is not applicable to global security policies.",
"readOnly": true,
"type": "string"
},
"rules": {
"description": "A list of rules that belong to this policy.\nThere must always be a default rule which is a rule with priority\n2147483647 and match all condition (for the match condition this means\nmatch  \"*\" for srcIpRanges and for the networkMatch condition every field\nmust be either match \"*\" or not set). If no rules are provided when\ncreating a security policy, a default rule with action \"allow\" will be\nadded.",
"items": {
"$ref": "SecurityPolicyRule"
},
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"shortName": {
"description": "User-provided name of the organization security policy. The name should be\nunique in the organization in which the security policy is created. This\nshould only be used when SecurityPolicyType is CLOUD_ARMOR.\nThe name must be 1-63 characters long, and comply with\nhttps://www.ietf.org/rfc/rfc1035.txt. Specifically, the name must be 1-63\ncharacters long and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a\nlowercase letter, and all following characters must be a dash, lowercase\nletter, 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": {
"description": "The type indicates the intended use of the security policy.\n   \n   - CLOUD_ARMOR: Cloud Armor backend security policies can\n   be configured to filter incoming HTTP requests targeting backend services.\n   They filter requests before they hit the origin servers.\n   - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can\n   be configured to filter incoming HTTP requests targeting backend services\n   (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage).\n   They filter requests before the request is served from Google's cache.\n   - CLOUD_ARMOR_INTERNAL_SERVICE (preview only): Cloud Armor\n   internal service policies can be configured to filter HTTP requests\n   targeting services managed by Traffic Director in a service mesh. They\n   filter requests before the request is served from the application.\n\n- CLOUD_ARMOR_NETWORK: Cloud Armor network policies\ncan be configured to filter packets targeting network load balancing\nresources such as backend services, target pools, target instances, and\ninstances with external IPs. They filter requests before the request is\nserved from the application.\n\n\nThis field can be set only at resource creation time.",
"enum": [
"CLOUD_ARMOR",
"CLOUD_ARMOR_EDGE",
"CLOUD_ARMOR_NETWORK"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"userDefinedFields": {
"description": "Definitions of user-defined fields for CLOUD_ARMOR_NETWORK policies. A\nuser-defined field consists of up to 4 bytes extracted from a fixed offset\nin the packet, relative to the IPv4, IPv6, TCP, or UDP header, with an\noptional mask to select certain bits. Rules may then specify matching\nvalues for these fields.\n\nExample:\n\n userDefinedFields:\n - name: \"ipv4_fragment_offset\"\n   base: IPV4\n   offset: 6\n   size: 2\n   mask: \"0x1fff\"",
"items": {
"$ref": "SecurityPolicyUserDefinedField"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyAdaptiveProtectionConfig": {
"description": "Configuration options for Cloud Armor Adaptive Protection (CAAP).",
"id": "SecurityPolicyAdaptiveProtectionConfig",
"properties": {
"layer7DdosDefenseConfig": {
"$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
"description": "If set to true, enables Cloud Armor Machine Learning."
}
},
"type": "object"
},
"SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig": {
"description": "Configuration options for L7 DDoS detection.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR.",
"id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfig",
"properties": {
"enable": {
"description": "If set to true, enables CAAP for L7 DDoS detection.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR.",
"type": "boolean"
},
"ruleVisibility": {
"description": "Rule visibility can be one of the following:\nSTANDARD - opaque rules. (default)\nPREMIUM - transparent rules.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR.",
"enum": [
"PREMIUM",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"thresholdConfigs": {
"description": "Configuration options for layer7 adaptive protection for various\ncustomizable thresholds.",
"items": {
"$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig": {
"id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfig",
"properties": {
"autoDeployConfidenceThreshold": {
"format": "float",
"type": "number"
},
"autoDeployExpirationSec": {
"format": "int32",
"type": "integer"
},
"autoDeployImpactedBaselineThreshold": {
"format": "float",
"type": "number"
},
"autoDeployLoadThreshold": {
"format": "float",
"type": "number"
},
"detectionAbsoluteQps": {
"format": "float",
"type": "number"
},
"detectionLoadThreshold": {
"format": "float",
"type": "number"
},
"detectionRelativeToBaselineQps": {
"format": "float",
"type": "number"
},
"name": {
"description": "The name must be 1-63 characters long, and comply withRFC1035.\nThe name must be unique within the security policy.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"trafficGranularityConfigs": {
"description": "Configuration options for enabling Adaptive Protection to operate\non specified granular traffic units.",
"items": {
"$ref": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig": {
"description": "Configurations to specifc granular traffic units processed by\nAdaptive Protection.",
"id": "SecurityPolicyAdaptiveProtectionConfigLayer7DdosDefenseConfigThresholdConfigTrafficGranularityConfig",
"properties": {
"enableEachUniqueValue": {
"description": "If enabled, traffic matching each unique value for the specified\ntype constitutes a separate traffic unit.\nIt can only be set to true if `value` is empty.",
"type": "boolean"
},
"type": {
"description": "Type of this configuration.",
"enum": [
"HTTP_HEADER_HOST",
"HTTP_PATH",
"UNSPECIFIED_TYPE"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"value": {
"description": "Requests that match this value constitute a granular traffic unit.",
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyAdvancedOptionsConfig": {
"id": "SecurityPolicyAdvancedOptionsConfig",
"properties": {
"jsonCustomConfig": {
"$ref": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig",
"description": "Custom configuration to apply the JSON parsing. Only applicable when\njson_parsing is set to STANDARD."
},
"jsonParsing": {
"enum": [
"DISABLED",
"STANDARD",
"STANDARD_WITH_GRAPHQL"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"logLevel": {
"enum": [
"NORMAL",
"VERBOSE"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"requestBodyInspectionSize": {
"description": "The maximum request size chosen by the customer with Waf enabled.\nValues supported are \"8KB\", \"16KB, \"32KB\", \"48KB\" and \"64KB\".\nValues are case insensitive.",
"type": "string"
},
"userIpRequestHeaders": {
"description": "An optional list of case-insensitive request header names to use for\nresolving the callers client IP address.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyAdvancedOptionsConfigJsonCustomConfig": {
"id": "SecurityPolicyAdvancedOptionsConfigJsonCustomConfig",
"properties": {
"contentTypes": {
"description": "A list of custom Content-Type header values to apply the JSON parsing.\n\nAs per RFC 1341, a Content-Type header value has the following format:\n\nContent-Type := type \"/\" subtype *[\";\" parameter]\n\nWhen configuring a custom Content-Type header value, only the\ntype/subtype needs to be specified, and the parameters should be\nexcluded.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyAssociation": {
"id": "SecurityPolicyAssociation",
"properties": {
"attachmentId": {
"description": "The resource that the security policy is attached to.",
"type": "string"
},
"displayName": {
"deprecated": true,
"description": "Output only. [Output Only] The display name of the security policy of the association.",
"readOnly": true,
"type": "string"
},
"excludedFolders": {
"description": "A list of folders to exclude from the security policy.",
"items": {
"type": "string"
},
"type": "array"
},
"excludedProjects": {
"description": "A list of projects to exclude from the security policy.",
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"description": "The name for an association.",
"type": "string"
},
"securityPolicyId": {
"description": "Output only. [Output Only] The security policy ID of the association.",
"readOnly": true,
"type": "string"
},
"shortName": {
"description": "Output only. [Output Only] The short name of the security policy of the association.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyDdosProtectionConfig": {
"id": "SecurityPolicyDdosProtectionConfig",
"properties": {
"ddosProtection": {
"enum": [
"ADVANCED",
"ADVANCED_PREVIEW",
"STANDARD"
],
"enumDescriptions": [
"",
"",
""
],
"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. [Output Only] Type of resource. Alwayscompute#securityPolicyList for listsof securityPolicies",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SecurityPolicyRecaptchaOptionsConfig": {
"id": "SecurityPolicyRecaptchaOptionsConfig",
"properties": {
"redirectSiteKey": {
"description": "An optional field to supply a reCAPTCHA site key to be used for all the\nrules using the redirect action with the type of GOOGLE_RECAPTCHA under\nthe security policy. The specified site key needs to be created from the\nreCAPTCHA API. The user is responsible for the validity of the specified\nsite key. If not specified, a Google-managed site key is used.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR.",
"type": "string"
}
},
"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\nthe action to be taken when traffic matches this condition (allow or deny).",
"id": "SecurityPolicyRule",
"properties": {
"action": {
"description": "The Action to perform when the rule is matched.\nThe following are the valid actions:\n   \n   - allow: allow access to target.\n   - deny(STATUS): deny access to target, returns the\n   HTTP response code specified. Valid values for `STATUS`\n   are 403, 404, and 502.\n   - rate_based_ban: limit client traffic to the configured\n   threshold and ban the client if the traffic exceeds the threshold.\n   Configure parameters for this action in RateLimitOptions. Requires\n   rate_limit_options to be set.\n   - redirect: redirect to a different target. This can\n   either be an internal reCAPTCHA redirect, or an external URL-based\n   redirect via a 302 response. Parameters for this action can be configured\n   via redirectOptions. This action is only supported in Global Security\n   Policies of type CLOUD_ARMOR.\n   - throttle: limit\n   client traffic to the configured threshold. Configure parameters for this\n   action in rateLimitOptions. Requires rate_limit_options to be set for\n   this.\n   - fairshare (preview only): when traffic reaches the\n   threshold limit, requests from the clients matching this rule begin to be\n   rate-limited using the Fair Share algorithm. This action is only allowed\n   in security policies of type `CLOUD_ARMOR_INTERNAL_SERVICE`.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"headerAction": {
"$ref": "SecurityPolicyRuleHttpHeaderAction",
"description": "Optional, additional actions that are performed on headers.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR."
},
"kind": {
"default": "compute#securityPolicyRule",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#securityPolicyRule for security policy rules",
"readOnly": true,
"type": "string"
},
"match": {
"$ref": "SecurityPolicyRuleMatcher",
"description": "A match condition that incoming traffic is evaluated against.\nIf it evaluates to true, the corresponding 'action' is enforced."
},
"networkMatch": {
"$ref": "SecurityPolicyRuleNetworkMatcher",
"description": "A match condition that incoming packets are evaluated against for\nCLOUD_ARMOR_NETWORK security policies. If it matches, the corresponding\n'action' is enforced.\n\nThe match criteria for a rule consists of built-in match fields (like\n'srcIpRanges') and potentially multiple user-defined match fields\n('userDefinedFields').\n\nField values may be extracted directly from the packet or derived from it\n(e.g. 'srcRegionCodes'). Some fields may not be present in every packet\n(e.g. 'srcPorts'). A user-defined field is only present if the base\nheader is found in the packet and the entire field is in bounds.\n\nEach match field may specify which values can match it, listing one or\nmore ranges, prefixes, or exact values that are considered a match for\nthe field. A field value must be present in order to match a specified\nmatch field. If no match values are specified for a match field, then any\nfield value is considered to match it, and it's not required to be\npresent. For strings specifying '*' is also equivalent to match all.\n\nFor a packet to match a rule, all specified match fields must match the\ncorresponding field values derived from the packet.\n\nExample:\n\nnetworkMatch:\n  srcIpRanges:\n  - \"192.0.2.0/24\"\n  - \"198.51.100.0/24\"\n  userDefinedFields:\n  - name: \"ipv4_fragment_offset\"\n    values:\n    - \"1-0x1fff\"\n\nThe above match condition matches packets with a source IP in\n192.0.2.0/24 or 198.51.100.0/24 and a user-defined field named\n\"ipv4_fragment_offset\" with a value between 1 and 0x1fff inclusive."
},
"preconfiguredWafConfig": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfig",
"description": "Preconfigured WAF configuration to be applied for the rule. If the rule\ndoes not evaluate preconfigured WAF rules, i.e., if\nevaluatePreconfiguredWaf() is not used, this field will have no effect."
},
"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\nmust be a positive value between 0 and 2147483647.\nRules are evaluated from highest to lowest priority where 0 is the\nhighest priority and 2147483647 is the lowest priority.",
"format": "int32",
"type": "integer"
},
"rateLimitOptions": {
"$ref": "SecurityPolicyRuleRateLimitOptions",
"description": "Must be specified if the action is \"rate_based_ban\" or \"throttle\" or\n\"fairshare\". Cannot be specified for any other actions."
},
"redirectOptions": {
"$ref": "SecurityPolicyRuleRedirectOptions",
"description": "Parameters defining the redirect action. Cannot be specified for any\nother actions.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR."
}
},
"type": "object"
},
"SecurityPolicyRuleHttpHeaderAction": {
"id": "SecurityPolicyRuleHttpHeaderAction",
"properties": {
"requestHeadersToAdds": {
"description": "The list of request headers to add or overwrite if they're already\npresent.",
"items": {
"$ref": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRuleHttpHeaderActionHttpHeaderOption": {
"id": "SecurityPolicyRuleHttpHeaderActionHttpHeaderOption",
"properties": {
"headerName": {
"description": "The name of the header to set.",
"type": "string"
},
"headerValue": {
"description": "The value to set the named header to.",
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRuleMatcher": {
"description": "Represents a match condition that incoming traffic is evaluated against.\nExactly one field must be specified.",
"id": "SecurityPolicyRuleMatcher",
"properties": {
"config": {
"$ref": "SecurityPolicyRuleMatcherConfig",
"description": "The configuration options available when specifying versioned_expr.\nThis field must be specified if versioned_expr is specified and cannot\nbe specified if versioned_expr is not specified."
},
"expr": {
"$ref": "Expr",
"description": "User defined CEVAL expression.\nA CEVAL expression is used to specify match criteria such as origin.ip,\nsource.region_code and contents in the request header.\nExpressions containing `evaluateThreatIntelligence` require a Cloud\nArmor Enterprise subscription and are not supported in Edge Policies\nnor in Regional Policies. Expressions containing\n`evaluatePreconfiguredExpr('sourceiplist-*')` require a Cloud Armor\nEnterprise subscription and are only supported in Global Security\nPolicies."
},
"exprOptions": {
"$ref": "SecurityPolicyRuleMatcherExprOptions",
"description": "The configuration options available when specifying a user defined\nCEVAL expression (i.e., 'expr')."
},
"versionedExpr": {
"description": "Preconfigured versioned expression.\nIf this field is specified, config must also be specified.\nAvailable preconfigured expressions along with their requirements are:\nSRC_IPS_V1 - must specify the corresponding src_ip_range field in\nconfig.",
"enum": [
"SRC_IPS_V1"
],
"enumDescriptions": [
"Matches the source IP address of a request to the IP ranges supplied\nin config."
],
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRuleMatcherConfig": {
"id": "SecurityPolicyRuleMatcherConfig",
"properties": {
"srcIpRanges": {
"description": "CIDR IP address range.\nMaximum number of src_ip_ranges allowed is 10.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRuleMatcherExprOptions": {
"id": "SecurityPolicyRuleMatcherExprOptions",
"properties": {
"recaptchaOptions": {
"$ref": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions",
"description": "reCAPTCHA configuration options to be applied for the rule. If the\nrule does not evaluate reCAPTCHA tokens, this field has no effect."
}
},
"type": "object"
},
"SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions": {
"id": "SecurityPolicyRuleMatcherExprOptionsRecaptchaOptions",
"properties": {
"actionTokenSiteKeys": {
"description": "A list of site keys to be used during the validation of reCAPTCHA\naction-tokens. The provided site keys need to be created from\nreCAPTCHA API under the same project where the security policy is\ncreated.",
"items": {
"type": "string"
},
"type": "array"
},
"sessionTokenSiteKeys": {
"description": "A list of site keys to be used during the validation of reCAPTCHA\nsession-tokens. The provided site keys need to be created from\nreCAPTCHA API under the same project where the security policy is\ncreated.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRuleNetworkMatcher": {
"description": "Represents a match condition that incoming network traffic is evaluated\nagainst.",
"id": "SecurityPolicyRuleNetworkMatcher",
"properties": {
"destIpRanges": {
"description": "Destination IPv4/IPv6 addresses or CIDR prefixes, in standard text\nformat.",
"items": {
"type": "string"
},
"type": "array"
},
"destPorts": {
"description": "Destination port numbers for TCP/UDP/SCTP. Each element can be a 16-bit\nunsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").",
"items": {
"type": "string"
},
"type": "array"
},
"ipProtocols": {
"description": "IPv4 protocol / IPv6 next header (after extension headers). Each\nelement can be an 8-bit unsigned decimal number (e.g. \"6\"), range (e.g.\n\"253-254\"), or one of the following protocol names: \"tcp\", \"udp\",\n\"icmp\", \"esp\", \"ah\", \"ipip\", or \"sctp\".",
"items": {
"type": "string"
},
"type": "array"
},
"srcAsns": {
"description": "BGP Autonomous System Number associated with the source IP address.",
"items": {
"format": "uint32",
"type": "integer"
},
"type": "array"
},
"srcIpRanges": {
"description": "Source IPv4/IPv6 addresses or CIDR prefixes, in standard text format.",
"items": {
"type": "string"
},
"type": "array"
},
"srcPorts": {
"description": "Source port numbers for TCP/UDP/SCTP. Each element can be a 16-bit\nunsigned decimal number (e.g. \"80\") or range (e.g. \"0-1023\").",
"items": {
"type": "string"
},
"type": "array"
},
"srcRegionCodes": {
"description": "Two-letter ISO 3166-1 alpha-2 country code associated with the source\nIP address.",
"items": {
"type": "string"
},
"type": "array"
},
"userDefinedFields": {
"description": "User-defined fields. Each element names a defined field and lists the\nmatching values for that field.",
"items": {
"$ref": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch": {
"id": "SecurityPolicyRuleNetworkMatcherUserDefinedFieldMatch",
"properties": {
"name": {
"description": "Name of the user-defined field, as given in the definition.",
"type": "string"
},
"values": {
"description": "Matching values of the field. Each element can be a 32-bit unsigned\ndecimal or hexadecimal (starting with \"0x\") number (e.g. \"64\") or\nrange (e.g.  \"0x400-0x7ff\").",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRulePreconfiguredWafConfig": {
"id": "SecurityPolicyRulePreconfiguredWafConfig",
"properties": {
"exclusions": {
"description": "A list of exclusions to apply during preconfigured WAF evaluation.",
"items": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusion"
},
"type": "array"
}
},
"type": "object"
},
"SecurityPolicyRulePreconfiguredWafConfigExclusion": {
"id": "SecurityPolicyRulePreconfiguredWafConfigExclusion",
"properties": {
"requestCookiesToExclude": {
"description": "A list of request cookie names whose value will be excluded from\ninspection during preconfigured WAF evaluation.",
"items": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams"
},
"type": "array"
},
"requestHeadersToExclude": {
"description": "A list of request header names whose value will be excluded from\ninspection during preconfigured WAF evaluation.",
"items": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams"
},
"type": "array"
},
"requestQueryParamsToExclude": {
"description": "A list of request query parameter names whose value will be excluded\nfrom inspection during preconfigured WAF evaluation. Note that the\nparameter can be in the query string or in the POST body.",
"items": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams"
},
"type": "array"
},
"requestUrisToExclude": {
"description": "A list of request URIs from the request line to be excluded from\ninspection during preconfigured WAF evaluation. When specifying this\nfield, the query or fragment part should be excluded.",
"items": {
"$ref": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams"
},
"type": "array"
},
"targetRuleIds": {
"description": "A list of target rule IDs under the WAF rule set to apply the\npreconfigured WAF exclusion. If omitted, it refers to all the rule\nIDs under the WAF rule set.",
"items": {
"type": "string"
},
"type": "array"
},
"targetRuleSet": {
"description": "Target WAF rule set to apply the preconfigured WAF exclusion.",
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams": {
"id": "SecurityPolicyRulePreconfiguredWafConfigExclusionFieldParams",
"properties": {
"op": {
"description": "The match operator for the field.",
"enum": [
"CONTAINS",
"ENDS_WITH",
"EQUALS",
"EQUALS_ANY",
"STARTS_WITH"
],
"enumDescriptions": [
"The operator matches if the field value contains the specified\nvalue.",
"The operator matches if the field value ends with the specified\nvalue.",
"The operator matches if the field value equals the specified\nvalue.",
"The operator matches if the field value is any value.",
"The operator matches if the field value starts with the specified\nvalue."
],
"type": "string"
},
"val": {
"description": "The value of the field.",
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRuleRateLimitOptions": {
"id": "SecurityPolicyRuleRateLimitOptions",
"properties": {
"banDurationSec": {
"description": "Can only be specified if the action for the rule is\n\"rate_based_ban\". If specified, determines the time (in seconds)\nthe traffic will continue to be banned by the rate limit after the\nrate falls below the threshold.",
"format": "int32",
"type": "integer"
},
"banThreshold": {
"$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
"description": "Can only be specified if the action for the rule is\n\"rate_based_ban\". If specified, the key will be banned for the\nconfigured 'ban_duration_sec' when the number of requests that exceed\nthe 'rate_limit_threshold' also exceed this 'ban_threshold'."
},
"conformAction": {
"description": "Action to take for requests that are under the configured rate limit\nthreshold. Valid option is \"allow\" only.",
"type": "string"
},
"enforceOnKey": {
"description": "Determines the key to enforce the rate_limit_threshold on. Possible\nvalues are:\n   \n   - ALL: A single rate limit threshold is applied to all\n   the requests matching this rule. This is the default value if\n   \"enforceOnKey\" is not configured.\n   - IP: The source IP address of\n   the request is the key. Each IP has this limit enforced\n   separately.\n   - HTTP_HEADER: The value of the HTTP\n   header whose name is configured under \"enforceOnKeyName\". The key\n   value is truncated to the first 128 bytes of the header value. If no\n   such header is present in the request, the key type defaults toALL.\n   - XFF_IP: The first IP address (i.e. the\n   originating client IP address) specified in the list of IPs under\n   X-Forwarded-For HTTP header. If no such header is present or the value\n   is not a valid IP, the key defaults to the source IP address of\n   the request i.e. key type IP.\n   - HTTP_COOKIE: The value of the HTTP\n   cookie whose name is configured under \"enforceOnKeyName\". The key\n   value is truncated to the first 128 bytes of the cookie value. If no\n   such cookie is present in the request, the key type defaults toALL.\n   - HTTP_PATH: The URL path of the HTTP request. The key\n   value is truncated to the first 128 bytes. \n   - SNI: Server name indication in the TLS session of the\n   HTTPS request. The key value is truncated to the first 128 bytes. The\n   key type defaults to ALL on a HTTP session. \n   - REGION_CODE: The country/region from which the request\n   originates. \n   - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the\n   client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the\n   key type defaults to ALL. \n   - USER_IP: The IP address of the originating client,\n   which is resolved based on \"userIpRequestHeaders\" configured with the\n   security policy. If there is no \"userIpRequestHeaders\" configuration or\n   an IP address cannot be resolved from it, the key type defaults toIP. \n\n- TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the\nclient connects using HTTPS, HTTP/2 or HTTP/3. If not available, the\nkey type defaults to ALL. \nFor \"fairshare\" action, this value is limited to ALL i.e. a single rate\nlimit threshold is enforced for all the requests matching the rule.",
"enum": [
"ALL",
"HTTP_COOKIE",
"HTTP_HEADER",
"HTTP_PATH",
"IP",
"REGION_CODE",
"SNI",
"TLS_JA3_FINGERPRINT",
"TLS_JA4_FINGERPRINT",
"USER_IP",
"XFF_IP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
},
"enforceOnKeyConfigs": {
"description": "If specified, any combination of values of\nenforce_on_key_type/enforce_on_key_name is treated as the key on which\nratelimit threshold/action is enforced. You can specify up to 3\nenforce_on_key_configs. If enforce_on_key_configs is specified,\nenforce_on_key must not be specified.",
"items": {
"$ref": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig"
},
"type": "array"
},
"enforceOnKeyName": {
"description": "Rate limit key name applicable only for the following key types:\nHTTP_HEADER -- Name of the HTTP header whose value is taken as the key\nvalue.\nHTTP_COOKIE -- Name of the HTTP cookie whose value is taken as the key\nvalue.",
"type": "string"
},
"exceedAction": {
"description": "Action to take for requests that are above the configured rate limit\nthreshold, to either deny with a specified HTTP response code, or\nredirect to a different endpoint.\nValid options are `deny(STATUS)`, where valid values for\n`STATUS` are 403, 404, 429, and 502, and\n`redirect`, where the redirect parameters come from\n`exceedRedirectOptions` below.\nThe `redirect` action is only supported in Global Security Policies of\ntype CLOUD_ARMOR.",
"type": "string"
},
"exceedRedirectOptions": {
"$ref": "SecurityPolicyRuleRedirectOptions",
"description": "Parameters defining the redirect action that is used as the exceed\naction. Cannot be specified if the exceed action is not redirect.\nThis field is only supported in Global Security Policies of type\nCLOUD_ARMOR."
},
"rateLimitThreshold": {
"$ref": "SecurityPolicyRuleRateLimitOptionsThreshold",
"description": "Threshold at which to begin ratelimiting."
}
},
"type": "object"
},
"SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig": {
"id": "SecurityPolicyRuleRateLimitOptionsEnforceOnKeyConfig",
"properties": {
"enforceOnKeyName": {
"description": "Rate limit key name applicable only for the following key types:\nHTTP_HEADER -- Name of the HTTP header whose value is taken as the\nkey value. HTTP_COOKIE -- Name of the HTTP cookie whose value is\ntaken as the key value.",
"type": "string"
},
"enforceOnKeyType": {
"description": "Determines the key to enforce the rate_limit_threshold on. Possible\nvalues are:\n   \n   - ALL: A single rate limit threshold is applied to all\n   the requests matching this rule. This is the default value if\n   \"enforceOnKeyConfigs\" is not configured.\n   - IP: The source IP address of\n   the request is the key. Each IP has this limit enforced\n   separately.\n   - HTTP_HEADER: The value of the HTTP\n   header whose name is configured under \"enforceOnKeyName\". The key\n   value is truncated to the first 128 bytes of the header value. If no\n   such header is present in the request, the key type defaults toALL.\n   - XFF_IP: The first IP address (i.e. the\n   originating client IP address) specified in the list of IPs under\n   X-Forwarded-For HTTP header. If no such header is present or the\n   value is not a valid IP, the key defaults to the source IP address of\n   the request i.e. key type IP.\n   - HTTP_COOKIE: The value of the HTTP\n   cookie whose name is configured under \"enforceOnKeyName\". The key\n   value is truncated to the first 128 bytes of the cookie value. If no\n   such cookie is present in the request, the key type defaults toALL.\n   - HTTP_PATH: The URL path of the HTTP request. The key\n   value is truncated to the first 128 bytes. \n   - SNI: Server name indication in the TLS session of\n   the HTTPS request. The key value is truncated to the first 128 bytes.\n   The key type defaults to ALL on a HTTP session. \n   - REGION_CODE: The country/region from which the\n   request originates. \n   - TLS_JA3_FINGERPRINT: JA3 TLS/SSL fingerprint if the\n   client connects using HTTPS, HTTP/2 or HTTP/3. If not available, the\n   key type defaults to ALL. \n   - USER_IP: The IP address of the originating client,\n   which is resolved based on \"userIpRequestHeaders\" configured with the\n   security policy. If there is no \"userIpRequestHeaders\" configuration\n   or an IP address cannot be resolved from it, the key type defaults toIP. \n\n- TLS_JA4_FINGERPRINT: JA4 TLS/SSL fingerprint if the\nclient connects using HTTPS, HTTP/2 or HTTP/3. If not available, the\nkey type defaults to ALL.",
"enum": [
"ALL",
"HTTP_COOKIE",
"HTTP_HEADER",
"HTTP_PATH",
"IP",
"REGION_CODE",
"SNI",
"TLS_JA3_FINGERPRINT",
"TLS_JA4_FINGERPRINT",
"USER_IP",
"XFF_IP"
],
"enumDescriptions": [
"",
"",
"",
"",
"",
"",
"",
"",
"",
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyRuleRateLimitOptionsThreshold": {
"id": "SecurityPolicyRuleRateLimitOptionsThreshold",
"properties": {
"count": {
"description": "Number of HTTP(S) requests for calculating the threshold.",
"format": "int32",
"type": "integer"
},
"intervalSec": {
"description": "Interval over which the threshold is computed.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SecurityPolicyRuleRedirectOptions": {
"id": "SecurityPolicyRuleRedirectOptions",
"properties": {
"target": {
"description": "Target for the redirect action. This is required if the type is\nEXTERNAL_302 and cannot be specified for GOOGLE_RECAPTCHA.",
"type": "string"
},
"type": {
"description": "Type of the redirect action. Possible values are:\n   \n   - GOOGLE_RECAPTCHA: redirect to reCAPTCHA for manual\n   challenge assessment.\n   - EXTERNAL_302: redirect to a different URL via a 302\n   response.",
"enum": [
"EXTERNAL_302",
"GOOGLE_RECAPTCHA"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"SecurityPolicyUserDefinedField": {
"id": "SecurityPolicyUserDefinedField",
"properties": {
"base": {
"description": "The base relative to which 'offset' is measured. Possible values are:\n   \n   - IPV4: Points to the beginning of the IPv4 header.\n   - IPV6: Points to the beginning of the IPv6 header.\n   - TCP: Points to the beginning of the TCP header, skipping\n   over any IPv4 options or IPv6 extension headers. Not present for\n   non-first fragments.\n   - UDP: Points to the beginning of the UDP header, skipping\n   over any IPv4 options or IPv6 extension headers. Not present for\n   non-first fragments.\n\n\nrequired",
"enum": [
"IPV4",
"IPV6",
"TCP",
"UDP"
],
"enumDescriptions": [
"",
"",
"",
""
],
"type": "string"
},
"mask": {
"description": "If specified, apply this mask (bitwise AND) to the field to ignore bits\nbefore matching. Encoded as a hexadecimal number (starting with \"0x\").\nThe last byte of the field (in network byte order) corresponds to the\nleast significant byte of the mask.",
"type": "string"
},
"name": {
"description": "The name of this field. Must be unique within the policy.",
"type": "string"
},
"offset": {
"description": "Offset of the first byte of the field (in network byte order) relative to\n'base'.",
"format": "int32",
"type": "integer"
},
"size": {
"description": "Size of the field in bytes. Valid values: 1-4.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SecuritySettings": {
"description": "The authentication and authorization settings for a BackendService.",
"id": "SecuritySettings",
"properties": {
"awsV4Authentication": {
"$ref": "AWSV4Signature",
"description": "The configuration needed to generate a signature for access to private\nstorage buckets that support AWS's Signature Version 4 for authentication.\nAllowed only for INTERNET_IP_PORT and INTERNET_FQDN_PORT NEG backends."
},
"clientTlsPolicy": {
"description": "Optional. A URL referring to a networksecurity.ClientTlsPolicy resource\nthat describes how clients should authenticate with this service's\nbackends.\n\n clientTlsPolicy only applies to a globalBackendService with the loadBalancingScheme set\nto INTERNAL_SELF_MANAGED.\n\n If left blank, communications are not encrypted.",
"type": "string"
},
"subjectAltNames": {
"description": "Optional. A list of Subject Alternative Names (SANs) that the client\nverifies during a mutual TLS handshake with an server/endpoint for thisBackendService. When the server presents its X.509 certificate\nto the client, the client inspects the certificate'ssubjectAltName field. If the field contains one of the\nspecified values, the communication continues. Otherwise, it fails. This\nadditional check enables the client to verify that the server is authorized\nto run the requested service.\n\n Note that the contents of the server\ncertificate's subjectAltName field are configured by the\nPublic Key Infrastructure which provisions server identities.\n\n Only applies to a global BackendService withloadBalancingScheme set to INTERNAL_SELF_MANAGED.\nOnly applies when BackendService has an attachedclientTlsPolicy with clientCertificate (mTLS\nmode).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SerialPortOutput": {
"description": "An instance 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. [Output Only] Type of the resource. Alwayscompute#serialPortOutput for serial port output.",
"readOnly": true,
"type": "string"
},
"next": {
"description": "[Output Only] The position of the next byte of content, regardless of\nwhether the content exists, following the output returned in the `contents`\nproperty. Use this value in the next request as the start\nparameter.",
"format": "int64",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"start": {
"description": "The starting byte position of the output that was returned.\nThis should match the start parameter sent with the request.\nIf the serial console output exceeds the size of the buffer (1 MB), older\noutput is overwritten by newer content. The output start value will\nindicate the byte position of the output that was returned, which might be\ndifferent than the `start` value that was specified in the request.",
"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": [
"Node may associate with any physical server over its lifetime.",
"Node may associate with minimal physical servers over its lifetime.",
""
],
"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"
},
"ServiceAttachment": {
"description": "Represents a ServiceAttachment resource.\n\nA service attachment represents a service that a producer has exposed.\nIt encapsulates the load balancer which fronts the service runs and\na list of NAT IP ranges that the producers uses to represent\nthe consumers connecting to the service.",
"id": "ServiceAttachment",
"properties": {
"connectedEndpoints": {
"description": "Output only. [Output Only] An array of connections for all the consumers connected to\nthis service attachment.",
"items": {
"$ref": "ServiceAttachmentConnectedEndpoint"
},
"readOnly": true,
"type": "array"
},
"connectionPreference": {
"description": "The connection preference of service attachment. The value can be set\nto ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC\nservice attachment is one that always accepts the connection from consumer\nforwarding rules.",
"enum": [
"ACCEPT_AUTOMATIC",
"ACCEPT_MANUAL",
"CONNECTION_PREFERENCE_UNSPECIFIED"
],
"enumDescriptions": [
"",
"",
""
],
"type": "string"
},
"consumerAcceptLists": {
"description": "Specifies which consumer projects or networks are allowed to connect to the\nservice attachment. Each project or network has a connection limit. A given\nservice attachment can manage connections at either the project or network\nlevel. Therefore, both the accept and reject lists for a given service\nattachment must contain either only projects or only networks or only\nendpoints.",
"items": {
"$ref": "ServiceAttachmentConsumerProjectLimit"
},
"type": "array"
},
"consumerRejectLists": {
"description": "Specifies a list of projects or networks that are not allowed to connect to\nthis service attachment. The project can be specified using its project ID\nor project number and the network can be specified using its URL. A given\nservice attachment can manage connections at either the project or network\nlevel. Therefore, both the reject and accept lists for a given service\nattachment must contain either only projects or only networks.",
"items": {
"type": "string"
},
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"domainNames": {
"description": "If specified, the domain name will be used during the integration between\nthe PSC connected endpoints and the Cloud DNS. For example, this is a valid\ndomain name: \"p.mycompany.com.\". Current max number of domain names\nsupported is 1.",
"items": {
"type": "string"
},
"type": "array"
},
"enableProxyProtocol": {
"description": "If true, enable the proxy protocol which is for supplying client TCP/IP\naddress data in TCP connections that traverse proxies on their way to\ndestination servers.",
"type": "boolean"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a ServiceAttachment. An up-to-date fingerprint must\nbe provided in order to patch/update the ServiceAttachment; otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nServiceAttachment.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#serviceAttachment",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#serviceAttachment for service attachments.",
"readOnly": true,
"type": "string"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "Metadata of the service attachment.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.serviceAttachments.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"natSubnets": {
"description": "An array of URLs where each entry is the URL of a subnet provided\nby the service producer to use for NAT in this service attachment.",
"items": {
"type": "string"
},
"type": "array"
},
"producerForwardingRule": {
"deprecated": true,
"description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is\nserving the endpoint identified by this service attachment.",
"type": "string"
},
"propagatedConnectionLimit": {
"description": "The number of consumer spokes that connected Private Service Connect\nendpoints can be propagated to through Network Connectivity Center. This\nlimit lets the service producer limit how many propagated Private Service\nConnect connections can be established to this service attachment from a\nsingle consumer.\n\nIf the connection preference of the service attachment is ACCEPT_MANUAL,\nthe limit applies to each project or network that is listed in the consumer\naccept list. If the connection preference of the service attachment is\nACCEPT_AUTOMATIC, the limit applies to each project that contains a\nconnected endpoint.\n\nIf unspecified, the default propagated connection limit is 250.",
"format": "uint32",
"type": "integer"
},
"pscServiceAttachmentId": {
"$ref": "Uint128",
"description": "Output only. [Output Only] An 128-bit global unique ID of the PSC service attachment.",
"readOnly": true
},
"reconcileConnections": {
"description": "This flag determines whether a consumer accept/reject list change can\nreconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints.\n   \n   \n    -  If false, connection policy update will only affect existing PENDING\n    PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched\n    regardless how the connection policy is modified . \n   -  If true,\n    update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For\n    example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project\n    is added to the reject list.\n\n\nFor newly created service attachment, this boolean defaults to false.",
"type": "boolean"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the service attachment resides.\nThis field applies only to the region resource. You must specify this\nfield as part of the HTTP request URL. It is not settable as a field in\nthe request body.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"targetService": {
"description": "The URL of a service serving the endpoint identified by this service\nattachment.",
"type": "string"
}
},
"type": "object"
},
"ServiceAttachmentAggregatedList": {
"description": "Contains a list of ServiceAttachmentsScopedList.",
"id": "ServiceAttachmentAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "ServiceAttachmentsScopedList",
"description": "Name of the scope containing this set of ServiceAttachments."
},
"description": "A list of ServiceAttachmentsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#serviceAttachmentAggregatedList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ServiceAttachmentConnectedEndpoint": {
"description": "[Output Only] A connection connected to this service attachment.",
"id": "ServiceAttachmentConnectedEndpoint",
"properties": {
"consumerNetwork": {
"description": "The url of the consumer network.",
"type": "string"
},
"endpoint": {
"description": "The url of a connected endpoint.",
"type": "string"
},
"endpointWithId": {
"description": "The url of a connected endpoint with resource id.",
"type": "string"
},
"natIps": {
"description": "NAT IPs of the connected PSC endpoint and those of other endpoints\npropagated from it.",
"items": {
"type": "string"
},
"type": "array"
},
"propagatedConnectionCount": {
"description": "The number of consumer Network Connectivity Center spokes that the\nconnected Private Service Connect endpoint has propagated to.",
"format": "uint32",
"type": "integer"
},
"pscConnectionId": {
"description": "The PSC connection id of the connected endpoint.",
"format": "uint64",
"type": "string"
},
"status": {
"description": "The status of a connected endpoint to this service attachment.",
"enum": [
"ACCEPTED",
"CLOSED",
"NEEDS_ATTENTION",
"PENDING",
"REJECTED",
"STATUS_UNSPECIFIED"
],
"enumDescriptions": [
"The connection has been accepted by the producer.",
"The connection has been closed by the producer.",
"The connection has been accepted by the producer, but the producer\nneeds to take further action before the forwarding rule can serve\ntraffic.",
"The connection is pending acceptance by the producer.",
"The consumer is still connected but not using the connection.",
""
],
"type": "string"
}
},
"type": "object"
},
"ServiceAttachmentConsumerProjectLimit": {
"id": "ServiceAttachmentConsumerProjectLimit",
"properties": {
"connectionLimit": {
"description": "The value of the limit to set. For endpoint_url, the limit should be no\nmore than 1.",
"format": "uint32",
"type": "integer"
},
"endpointUrl": {
"description": "The URL for the PSC endpoint to accept",
"type": "string"
},
"networkUrl": {
"description": "The network URL for the network to set the limit for.",
"type": "string"
},
"projectIdOrNum": {
"description": "The project id or number for the project to set the limit for.",
"type": "string"
}
},
"type": "object"
},
"ServiceAttachmentList": {
"id": "ServiceAttachmentList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of ServiceAttachment resources.",
"items": {
"$ref": "ServiceAttachment"
},
"type": "array"
},
"kind": {
"default": "compute#serviceAttachmentList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#serviceAttachment for service attachments.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"ServiceAttachmentsScopedList": {
"id": "ServiceAttachmentsScopedList",
"properties": {
"serviceAttachments": {
"description": "A list of ServiceAttachments contained in this scope.",
"items": {
"$ref": "ServiceAttachment"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nservice attachments when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SetCommonInstanceMetadataOperationMetadata": {
"id": "SetCommonInstanceMetadataOperationMetadata",
"properties": {
"clientOperationId": {
"description": "[Output Only] The client operation id.",
"type": "string"
},
"perLocationOperations": {
"additionalProperties": {
"$ref": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo"
},
"description": "[Output Only] Status information per location (location name is key).\nExample key: zones/us-central1-a",
"type": "object"
}
},
"type": "object"
},
"SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo": {
"id": "SetCommonInstanceMetadataOperationMetadataPerLocationOperationInfo",
"properties": {
"error": {
"$ref": "Status",
"description": "[Output Only] If state is `ABANDONED` or `FAILED`, this field is\npopulated."
},
"state": {
"description": "[Output Only] Status of the action, which can be one of the following:\n`PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.",
"enum": [
"ABANDONED",
"DONE",
"FAILED",
"PROPAGATED",
"PROPAGATING",
"UNSPECIFIED"
],
"enumDescriptions": [
"Operation not tracked in this location e.g. zone is marked as DOWN.",
"Operation has completed successfully.",
"Operation is in an error state.",
"Operation is confirmed to be in the location.",
"Operation is not yet confirmed to have been created in the location.",
""
],
"type": "string"
}
},
"type": "object"
},
"ShareSettings": {
"description": "The share setting for reservations and sole tenancy node groups.",
"id": "ShareSettings",
"properties": {
"projectMap": {
"additionalProperties": {
"$ref": "ShareSettingsProjectConfig"
},
"description": "A map of project id and project config. This is only valid when\nshare_type's value is SPECIFIC_PROJECTS.",
"type": "object"
},
"shareType": {
"description": "Type of sharing for this shared-reservation",
"enum": [
"LOCAL",
"ORGANIZATION",
"SHARE_TYPE_UNSPECIFIED",
"SPECIFIC_PROJECTS"
],
"enumDescriptions": [
"Default value.",
"Shared-reservation is open to entire Organization",
"Default value. This value is unused.",
"Shared-reservation is open to specific projects"
],
"type": "string"
}
},
"type": "object"
},
"ShareSettingsProjectConfig": {
"description": "Config for each project in the share settings.",
"id": "ShareSettingsProjectConfig",
"properties": {
"projectId": {
"description": "The project ID, should be same as the key of this project config in the\nparent map.",
"type": "string"
}
},
"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\ndefault.",
"type": "boolean"
},
"enableSecureBoot": {
"description": "Defines whether the instance has Secure Boot enabled.Disabled by\ndefault.",
"type": "boolean"
},
"enableVtpm": {
"description": "Defines whether the instance has the vTPM enabled.Enabled by\ndefault.",
"type": "boolean"
}
},
"type": "object"
},
"ShieldedInstanceIdentity": {
"description": "A Shielded Instance Identity.",
"id": "ShieldedInstanceIdentity",
"properties": {
"eccP256EncryptionKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Endorsement Key (EK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
},
"eccP256SigningKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Attestation Key (AK) made by the ECC P256 algorithm\nissued to the Shielded Instance's vTPM."
},
"encryptionKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Endorsement Key (EK) made by the RSA 2048 algorithm\nissued to the Shielded Instance's vTPM."
},
"kind": {
"default": "compute#shieldedInstanceIdentity",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#shieldedInstanceIdentity for shielded Instance\nidentity entry.",
"readOnly": true,
"type": "string"
},
"signingKey": {
"$ref": "ShieldedInstanceIdentityEntry",
"description": "An Attestation Key (AK) made by the RSA 2048 algorithm\nissued 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\nInstance boot integrity is measured.",
"id": "ShieldedInstanceIntegrityPolicy",
"properties": {
"updateAutoLearnPolicy": {
"description": "Updates the integrity policy baseline using the\nmeasurements 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 withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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 validRFC\n4648 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\ninformation, read  Creating\npersistent disk snapshots.",
"id": "Snapshot",
"properties": {
"architecture": {
"description": "Output only. [Output Only] The architecture of the snapshot. Valid values are\nARM64 or X86_64.",
"enum": [
"ARCHITECTURE_UNSPECIFIED",
"ARM64",
"X86_64"
],
"enumDescriptions": [
"Default value indicating Architecture is not set.",
"Machines with architecture ARM64",
"Machines with architecture X86_64"
],
"readOnly": true,
"type": "string"
},
"autoCreated": {
"description": "Output only. [Output Only] Set to true if snapshots are automatically created by\napplying resource policy on the target disk.",
"readOnly": true,
"type": "boolean"
},
"chainName": {
"description": "Creates the new snapshot in the snapshot chain labeled with the\nspecified name. The chain name must be 1-63 characters long and comply\nwith RFC1035. This is an uncommon option only for advanced service\nowners who needs to create separate snapshot chains, for example,\nfor chargeback tracking. When you describe your snapshot resource, this\nfield is visible only if it has a non-empty value.",
"type": "string"
},
"creationSizeBytes": {
"description": "Output only. [Output Only] Size in bytes of the snapshot at creation time.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"diskSizeGb": {
"description": "Output only. [Output Only] Size of the source disk, specified in GB.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"downloadBytes": {
"description": "Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"enableConfidentialCompute": {
"description": "Output only. Whether this snapshot is created from a confidential compute mode disk.\n[Output Only]: This field is not set by user, but from source disk.",
"readOnly": true,
"type": "boolean"
},
"guestFlush": {
"description": "[Input Only] Whether to attempt an application consistent snapshot by\ninforming the OS to prepare for the snapshot process.",
"type": "boolean"
},
"guestOsFeatures": {
"description": "Output only. [Output Only] A list of features to enable on the guest operating system.\nApplicable only for bootable images. Read \nEnabling guest operating system features to see a list of available\noptions.",
"items": {
"$ref": "GuestOsFeature"
},
"readOnly": true,
"type": "array"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#snapshot",
"description": "Output only. [Output Only] Type of the resource. Always compute#snapshot\nfor Snapshot resources.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this snapshot, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a snapshot.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this snapshot. These can be later modified by\nthe setLabels method.\nLabel values may be empty.",
"type": "object"
},
"licenseCodes": {
"description": "Output only. [Output Only] Integer license codes indicating which licenses are attached\nto this snapshot.",
"items": {
"format": "int64",
"type": "string"
},
"readOnly": true,
"type": "array"
},
"licenses": {
"description": "Output only. [Output Only] A list of public visible licenses that apply to this\nsnapshot. This can be because the original image had licenses attached\n(such as a Windows image).",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"locationHint": {
"description": "An opaque location hint used to place the snapshot close to other\nresources.\nThis field is for use by internal tools that use the public API.",
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.disks.createSnapshot",
"compute.snapshots.insert"
]
},
"description": "Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "SnapshotParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "Output only. [Output Only] URL of the region where the snapshot resides. Only applicable\nfor regional snapshots.",
"readOnly": true,
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"snapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and you\ndo not need to provide a key to use the snapshot later."
},
"snapshotGroupId": {
"description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.",
"readOnly": true,
"type": "string"
},
"snapshotGroupName": {
"description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.",
"readOnly": true,
"type": "string"
},
"snapshotType": {
"description": "Indicates the type of the snapshot.",
"enum": [
"ARCHIVE",
"STANDARD"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"sourceDisk": {
"description": "The source disk used to create this snapshot.",
"type": "string"
},
"sourceDiskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "The customer-supplied\nencryption key of the source disk. Required if the source disk is\nprotected by a customer-supplied encryption key."
},
"sourceDiskForRecoveryCheckpoint": {
"description": "The source disk whose recovery checkpoint will be used to create this\nsnapshot.",
"type": "string"
},
"sourceDiskId": {
"description": "Output only. [Output Only] The ID value of the disk used to create this snapshot. This\nvalue may be used to determine whether the snapshot was taken from the\ncurrent or a previous instance of a given disk name.",
"readOnly": true,
"type": "string"
},
"sourceInstantSnapshot": {
"description": "The source instant snapshot used to create this snapshot. You can provide\nthis as a partial or full URL to the resource. For example, the following\nare valid values:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/zones/zone/instantSnapshots/instantSnapshot\n     - projects/project/zones/zone/instantSnapshots/instantSnapshot \n   - zones/zone/instantSnapshots/instantSnapshot",
"type": "string"
},
"sourceInstantSnapshotEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Customer provided encryption key when creating Snapshot from Instant\nSnapshot."
},
"sourceInstantSnapshotId": {
"description": "Output only. [Output Only] The unique ID of the instant snapshot used to create this\nsnapshot. This value identifies the exact instant snapshot that was used to\ncreate this snapshot. For example, if you created the snapshot from an\ninstant snapshot that was later deleted and recreated under the same name,\nthe source instant snapshot ID would identify the exact instant snapshot\nthat was used.",
"readOnly": true,
"type": "string"
},
"sourceSnapshotSchedulePolicy": {
"description": "Output only. [Output Only] URL of the resource policy which created this\nscheduled snapshot.",
"readOnly": true,
"type": "string"
},
"sourceSnapshotSchedulePolicyId": {
"description": "Output only. [Output Only] ID of the resource policy which created this\nscheduled snapshot.",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The status of the snapshot. This can beCREATING, DELETING, FAILED,READY, or UPLOADING.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"UPLOADING"
],
"enumDescriptions": [
"Snapshot creation is in progress.",
"Snapshot is currently being deleted.",
"Snapshot creation failed.",
"Snapshot has been created successfully.",
"Snapshot is being uploaded."
],
"readOnly": true,
"type": "string"
},
"storageBytes": {
"description": "Output only. [Output Only] A size of the storage used by the snapshot. As snapshots\nshare storage, this number is expected to change with snapshot\ncreation/deletion.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"storageBytesStatus": {
"description": "Output only. [Output Only] An indicator whether storageBytes is in a\nstable state or it is being adjusted as a result of shared storage\nreallocation. This status can either be UPDATING, meaning\nthe size of the snapshot is being updated, or UP_TO_DATE,\nmeaning the size of the snapshot is up-to-date.",
"enum": [
"UPDATING",
"UP_TO_DATE"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
},
"storageLocations": {
"description": "Cloud Storage bucket storage location of the snapshot (regional or\nmulti-regional).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SnapshotGroupParameters": {
"id": "SnapshotGroupParameters",
"properties": {
"replicaZones": {
"description": "URLs of the zones where disks should be replicated to. Only applicable\nfor regional resources.",
"items": {
"type": "string"
},
"type": "array"
},
"sourceSnapshotGroup": {
"description": "The source snapshot group used to create disks. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n   \n   \n     - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup \n   - projects/project/global/snapshotGroups/snapshotGroup\n     - global/snapshotGroups/snapshotGroup",
"type": "string"
},
"type": {
"description": "URL of the disk type resource describing which disk type to use to create\ndisks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.",
"type": "string"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SnapshotParams": {
"description": "Additional snapshot params.",
"id": "SnapshotParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"SnapshotSettings": {
"id": "SnapshotSettings",
"properties": {
"accessLocation": {
"$ref": "SnapshotSettingsAccessLocation",
"description": "(Regional snapshots use only)Policy of which location is allowed to access\nsnapshot."
},
"storageLocation": {
"$ref": "SnapshotSettingsStorageLocationSettings",
"description": "Policy of which storage location is going to be resolved, and additional\ndata that particularizes how the policy is going to be carried out."
}
},
"type": "object"
},
"SnapshotSettingsAccessLocation": {
"id": "SnapshotSettingsAccessLocation",
"properties": {
"locations": {
"additionalProperties": {
"$ref": "SnapshotSettingsAccessLocationAccessLocationPreference"
},
"description": "List of regions that can restore a regional\n snapshot from the current region",
"type": "object"
},
"policy": {
"description": "Policy of which location is allowed to access snapshot.",
"enum": [
"ALL_REGIONS",
"POLICY_UNSPECIFIED",
"SPECIFIC_REGIONS"
],
"enumDescriptions": [
"Any regions will be able to access the source location.",
"",
"Only allowlisted regions will be able to restore region scoped\nsnapshots"
],
"type": "string"
}
},
"type": "object"
},
"SnapshotSettingsAccessLocationAccessLocationPreference": {
"description": "A structure for specifying an allowed target region.",
"id": "SnapshotSettingsAccessLocationAccessLocationPreference",
"properties": {
"region": {
"description": "Accessible region name",
"type": "string"
}
},
"type": "object"
},
"SnapshotSettingsStorageLocationSettings": {
"id": "SnapshotSettingsStorageLocationSettings",
"properties": {
"locations": {
"additionalProperties": {
"$ref": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference"
},
"description": "When the policy is SPECIFIC_LOCATIONS, snapshots will be stored\nin the locations listed in this field. Keys are Cloud Storage bucket\nlocations. Only one location can be specified.",
"type": "object"
},
"policy": {
"description": "The chosen location policy.",
"enum": [
"LOCAL_REGION",
"NEAREST_MULTI_REGION",
"SPECIFIC_LOCATIONS",
"STORAGE_LOCATION_POLICY_UNSPECIFIED"
],
"enumDescriptions": [
"Store snapshot in the same region as with the originating disk.\nNo additional parameters are needed.",
"Store snapshot in the nearest multi region Cloud Storage bucket,\nrelative to the originating disk. No additional parameters are needed.",
"Store snapshot in the specific locations, as specified by the user.\nThe list of regions to store must be defined under the `locations`\nfield.",
""
],
"type": "string"
}
},
"type": "object"
},
"SnapshotSettingsStorageLocationSettingsStorageLocationPreference": {
"description": "A structure for specifying storage locations.",
"id": "SnapshotSettingsStorageLocationSettingsStorageLocationPreference",
"properties": {
"name": {
"description": "Name of the location. It should be one of the Cloud Storage buckets.\nOnly one location can be specified.",
"type": "string"
}
},
"type": "object"
},
"SnapshotUpdateKmsKeyRequest": {
"id": "SnapshotUpdateKmsKeyRequest",
"properties": {
"kmsKeyName": {
"description": "Optional. The new KMS key to replace the current one on the snapshot. If empty, the\nsnapshot will be re-encrypted using the primary version of the snapshot's\ncurrent KMS key.\n\nThe KMS key can be provided in the following formats:\n   \n   \n     - projects/project_id/locations/region/keyRings/key_ring/cryptoKeys/key",
"type": "string"
}
},
"type": "object"
},
"SourceDiskEncryptionKey": {
"id": "SourceDiskEncryptionKey",
"properties": {
"diskEncryptionKey": {
"$ref": "CustomerEncryptionKey",
"description": "Thecustomer-supplied\nencryption key of the source disk. Required if the source disk is\nprotected by a customer-supplied encryption key."
},
"sourceDisk": {
"description": "URL of the disk attached to the source instance. This can be a full or\nvalid partial URL. For example, the following are valid values:\n   \n   \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"
},
"SourceInstanceParams": {
"description": "A specification of the parameters to use when creating the instance template\nfrom a source instance.",
"id": "SourceInstanceParams",
"properties": {
"diskConfigs": {
"description": "Attached disks configuration. If not provided, defaults are applied:\nFor boot disk and any other R/W disks, the source images for each disk\nwill be used. For read-only disks, they will be attached in read-only\nmode. Local SSD disks will be created as blank volumes.",
"items": {
"$ref": "DiskInstantiationConfig"
},
"type": "array"
}
},
"type": "object"
},
"SourceInstanceProperties": {
"description": "DEPRECATED: Please use compute#instanceProperties instead.\nNew properties will not be added to this field.",
"id": "SourceInstanceProperties",
"properties": {
"canIpForward": {
"description": "Enables instances created based on this machine image to send packets with\nsource IP addresses other than their own and receive packets with\ndestination IP addresses other than their own. If these instances will be\nused as an IP gateway or it will be set as the next-hop in a Route\nresource, specify true. If unsure, leave this set tofalse. See theEnable IP forwarding\ndocumentation for more information.",
"type": "boolean"
},
"deletionProtection": {
"description": "Whether the instance created from this machine image should be protected\nagainst deletion.",
"type": "boolean"
},
"description": {
"description": "An optional text description for the instances that are created from this\nmachine image.",
"type": "string"
},
"disks": {
"description": "An array of disks that are associated with the instances that are created\nfrom this machine image.",
"items": {
"$ref": "SavedAttachedDisk"
},
"type": "array"
},
"guestAccelerators": {
"description": "A list of guest accelerator cards' type and count to use for instances\ncreated from this machine image.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"keyRevocationActionType": {
"description": "KeyRevocationActionType of the instance. Supported options are \"STOP\" and\n\"NONE\". The default value is \"NONE\" if it is not specified.",
"enum": [
"KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
"NONE",
"STOP"
],
"enumDescriptions": [
"Default value. This value is unused.",
"Indicates user chose no operation.",
"Indicates user chose to opt for VM shutdown on key revocation."
],
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to instances that are created from this machine image.",
"type": "object"
},
"machineType": {
"description": "The machine type to use for instances that are created from this machine\nimage.",
"type": "string"
},
"metadata": {
"$ref": "Metadata",
"description": "The metadata key/value pairs to assign to instances that are created from\nthis machine image. These pairs can consist of custom metadata or\npredefined keys. SeeProject and\ninstance metadata for more information."
},
"minCpuPlatform": {
"description": "Minimum cpu/platform to be used by instances created from this machine\nimage. The instance may be scheduled on the specified or newer\ncpu/platform. Applicable values are the friendly names of CPU platforms,\nsuch as minCpuPlatform: \"Intel Haswell\" orminCpuPlatform: \"Intel Sandy Bridge\". For more\ninformation, read Specifying a\nMinimum CPU Platform.",
"type": "string"
},
"networkInterfaces": {
"description": "An array of network access configurations for this interface.",
"items": {
"$ref": "NetworkInterface"
},
"type": "array"
},
"postKeyRevocationActionType": {
"description": "PostKeyRevocationActionType of the instance.",
"enum": [
"NOOP",
"POST_KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED",
"SHUTDOWN"
],
"enumDescriptions": [
"Indicates user chose no operation.",
"Default value. This value is unused.",
"Indicates user chose to opt for VM shutdown on key revocation."
],
"type": "string"
},
"scheduling": {
"$ref": "Scheduling",
"description": "Specifies the scheduling options for the instances that are created from\nthis machine image."
},
"serviceAccounts": {
"description": "A list of service accounts with specified scopes. Access tokens for these\nservice accounts are available to the instances that are created from this\nmachine image. Use metadata queries to obtain the access tokens for these\ninstances.",
"items": {
"$ref": "ServiceAccount"
},
"type": "array"
},
"tags": {
"$ref": "Tags",
"description": "A list of tags to apply to the instances that are created from this machine\nimage. The tags identify valid sources or targets for network firewalls.\nThe setTags method can modify this list of tags. Each tag within the list\nmust comply withRFC1035."
}
},
"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/v1/sslCertificates)\n* [Regional](/compute/docs/reference/rest/v1/regionSslCertificates)\n\n\nThe global SSL certificates (sslCertificates) are used by:\n   \n   - Global external Application Load Balancers\n   - Classic Application Load Balancers\n   - Proxy Network Load Balancers (with target SSL proxies)\n\n\n\nThe regional SSL certificates (regionSslCertificates) are used\nby:\n   \n   - Regional external Application Load Balancers\n   - Regional internal Application Load Balancers\n\n\n\nOptionally, certificate file contents that you upload can contain a set of up\nto five PEM-encoded certificates.\nThe API call creates an object (sslCertificate) that holds this data.\nYou can use SSL keys and certificates to secure connections to a load\nbalancer.\nFor more information, read \nCreating and using SSL certificates,SSL certificates\nquotas and limits, and\nTroubleshooting SSL certificates.",
"id": "SslCertificate",
"properties": {
"certificate": {
"description": "A value read into memory from a certificate file. The certificate file must\nbe in PEM format. The certificate chain must be no greater than 5 certs\nlong. The chain must include at least one intermediate cert.",
"type": "string"
},
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"expireTime": {
"description": "Output only. [Output Only] Expire time of the certificate. RFC3339",
"readOnly": true,
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#sslCertificate",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#sslCertificate for SSL certificates.",
"readOnly": true,
"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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"privateKey": {
"description": "A value read into memory from a write-only private key file. The private\nkey file must be in PEM format. For security, only insert\nrequests include this field.",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional SSL Certificate\nresides. This field is not applicable to global SSL Certificate.",
"readOnly": true,
"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. [Output Only] Domains associated with the certificate via Subject\nAlternative Name.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"type": {
"description": "(Optional) Specifies the type of SSL certificate, either \"SELF_MANAGED\" or\n\"MANAGED\". If not specified, the certificate is self-managed and the fieldscertificate and private_key are used.",
"enum": [
"MANAGED",
"SELF_MANAGED",
"TYPE_UNSPECIFIED"
],
"enumDescriptions": [
"Google-managed SSLCertificate.",
"Certificate uploaded by user.",
""
],
"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. [Output Only] Type of resource. Alwayscompute#sslCertificateAggregatedList for lists of SSL\nCertificates.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": [
"A managed certificate can be provisioned, no issues for this domain.",
"",
"Failed to check CAA records for the domain.",
"Certificate issuance forbidden by an explicit CAA record for the\ndomain.",
"There seems to be problem with the user's DNS or load balancer\nconfiguration for this domain.",
"Reached rate-limit for certificates per top-level private domain.",
"Certificate provisioning for this domain is under way. GCP will\nattempt to provision the first certificate."
],
"type": "string"
},
"description": "Output only. [Output only] Detailed statuses of the domains specified for managed\ncertificate resource.",
"readOnly": true,
"type": "object"
},
"domains": {
"description": "The domains for which a managed SSL certificate will be generated. Each\nGoogle-managed SSL certificate supports up to the [maximum number of\ndomains per Google-managed SSL\ncertificate](/load-balancing/docs/quotas#ssl_certificates).",
"items": {
"type": "string"
},
"type": "array"
},
"status": {
"description": "Output only. [Output only] Status of the managed certificate resource.",
"enum": [
"ACTIVE",
"MANAGED_CERTIFICATE_STATUS_UNSPECIFIED",
"PROVISIONING",
"PROVISIONING_FAILED",
"PROVISIONING_FAILED_PERMANENTLY",
"RENEWAL_FAILED"
],
"enumDescriptions": [
"The certificate management is working, and a certificate has been\nprovisioned.",
"",
"The certificate management is working. GCP will attempt to provision\nthe first certificate.",
"Certificate provisioning failed due to an issue with the DNS\nor load balancing configuration.\nFor details of which domain failed, consult domain_status field.",
"Certificate provisioning failed due to an issue with the DNS\nor load balancing configuration. It won't be retried. To try again\ndelete and create a new managed SslCertificate resource.\nFor details of which domain failed, consult domain_status field.",
"Renewal of the certificate has failed due to an issue with the DNS\nor load balancing configuration. The existing cert is still serving;\nhowever, it will expire shortly. To provision a renewed certificate,\ndelete and create a new managed SslCertificate resource.\nFor details on which domain failed, consult domain_status field."
],
"readOnly": true,
"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\nPEM format. The certificate chain must be no greater than 5 certs\nlong. The chain must include at least one intermediate cert.",
"type": "string"
},
"privateKey": {
"description": "A write-only private key in PEM format. Only insert\nrequests 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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SslPoliciesAggregatedList": {
"id": "SslPoliciesAggregatedList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "SslPoliciesScopedList",
"description": "Name of the scope containing this set of SSL policies."
},
"description": "A list of SslPoliciesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#sslPoliciesAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#sslPolicyAggregatedList for lists of SSL Policies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "Output only. A list of SslPolicy resources.",
"items": {
"$ref": "SslPolicy"
},
"readOnly": true,
"type": "array"
},
"kind": {
"default": "compute#sslPoliciesList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#sslPoliciesList for lists of sslPolicies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SslPoliciesScopedList": {
"id": "SslPoliciesScopedList",
"properties": {
"sslPolicies": {
"description": "A list of SslPolicies contained in this scope.",
"items": {
"$ref": "SslPolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nSSL policies when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SslPolicy": {
"description": "Represents an SSL Policy resource.\n\nUse SSL policies to control SSL features, such as versions and cipher\nsuites, that are offered by Application Load Balancers and proxy Network Load\nBalancers. For more information, read \nSSL policies overview.",
"id": "SslPolicy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"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\nspecified in this list. This field must be empty if the profile is notCUSTOM.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"enabledFeatures": {
"description": "Output only. [Output Only] The list of features enabled in the SSL policy.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a SslPolicy. An up-to-date fingerprint must be\nprovided in order to update the SslPolicy, otherwise the\nrequest will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve an SslPolicy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#sslPolicy",
"description": "Output only. [Output only] Type of the resource. Alwayscompute#sslPolicyfor SSL policies.",
"readOnly": true,
"type": "string"
},
"minTlsVersion": {
"description": "The minimum version of SSL protocol that can be used by the clients to\nestablish a connection with the load balancer. This can be one ofTLS_1_0, TLS_1_1, TLS_1_2,TLS_1_3. When set to TLS_1_3, the profile field\nmust be set to RESTRICTED.",
"enum": [
"TLS_1_0",
"TLS_1_1",
"TLS_1_2",
"TLS_1_3"
],
"enumDescriptions": [
"TLS 1.0",
"TLS 1.1",
"TLS 1.2",
"TLS 1.3"
],
"type": "string"
},
"name": {
"description": "Name of the resource. The name must be 1-63 characters long, and comply\nwith RFC1035. Specifically, the name must be 1-63 characters\nlong and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character\nmust be a lowercase letter, and all following characters must be a dash,\nlowercase letter, or digit, except the last character, which cannot be a\ndash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"postQuantumKeyExchange": {
"description": "One of DEFAULT, ENABLED, orDEFERRED. Controls whether the load balancer negotiates\nX25519MLKEM768 key exchange when clients advertise support for it. When set\nto DEFAULT, or if no SSL Policy is attached to the target\nproxy, the load balancer disallows X25519MLKEM768 key exchange before\nOctober 2026, and allows it afterward. When set to ENABLED,\nthe load balancer allows X25519MLKEM768 key exchange. When set toDEFERRED, the load balancer disallows X25519MLKEM768 key\nexchange until October 2027, and allows it afterward.",
"enum": [
"DEFAULT",
"DEFERRED",
"ENABLED"
],
"enumDescriptions": [
"Default behavior: disabled until October 2026, enabled afterward.",
"Disabled until October 2027, enabled afterward.",
"Enabled now."
],
"type": "string"
},
"profile": {
"description": "Profile specifies the set of SSL features that can be used by the load\nbalancer when negotiating SSL with clients. This can be one ofCOMPATIBLE, MODERN, RESTRICTED,FIPS_202205, or CUSTOM. If usingCUSTOM, the set of SSL features to enable must be specified in\nthe customFeatures field. If using FIPS_202205,\nthe min_tls_version field must be set to TLS_1_2.",
"enum": [
"COMPATIBLE",
"CUSTOM",
"FIPS_202205",
"MODERN",
"RESTRICTED"
],
"enumDescriptions": [
"Compatible profile. Allows the broadset set of clients, even those which\nsupport only out-of-date SSL features to negotiate with the load\nbalancer.",
"Custom profile. Allow only the set of allowed SSL features specified in\nthe customFeatures field.",
"FIPS compatible profile. Supports a reduced set of SSL features,\nintended to meet FIPS 140-3 compliance requirements.",
"Modern profile. Supports a wide set of SSL features, allowing modern\nclients to negotiate SSL with the load balancer.",
"Restricted profile. Supports a reduced set of SSL features, intended to\nmeet stricter compliance requirements."
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional SSL policy\nresides. This field is not applicable to global SSL policies.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"warnings": {
"description": "Output only. [Output Only] If potential misconfigurations are detected for this\nSSL policy, this field will be populated with warning messages.",
"items": {
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"SslPolicyReference": {
"id": "SslPolicyReference",
"properties": {
"sslPolicy": {
"description": "URL of the SSL policy resource. Set this to empty string to clear any\nexisting SSL policy associated with the target proxy resource.",
"type": "string"
}
},
"type": "object"
},
"StatefulPolicy": {
"id": "StatefulPolicy",
"properties": {
"preservedState": {
"$ref": "StatefulPolicyPreservedState"
}
},
"type": "object"
},
"StatefulPolicyPreservedState": {
"description": "Configuration of preserved resources.",
"id": "StatefulPolicyPreservedState",
"properties": {
"disks": {
"additionalProperties": {
"$ref": "StatefulPolicyPreservedStateDiskDevice"
},
"description": "Disks created on the instances that will be preserved on instance\ndelete, update, etc. This map is keyed with the device names of\nthe disks.",
"type": "object"
},
"externalIPs": {
"additionalProperties": {
"$ref": "StatefulPolicyPreservedStateNetworkIp"
},
"description": "External network IPs assigned to the instances that will be preserved on\ninstance delete, update, etc. This map is keyed with the network\ninterface name.",
"type": "object"
},
"internalIPs": {
"additionalProperties": {
"$ref": "StatefulPolicyPreservedStateNetworkIp"
},
"description": "Internal network IPs assigned to the instances that will be preserved on\ninstance delete, update, etc. This map is keyed with the network\ninterface name.",
"type": "object"
}
},
"type": "object"
},
"StatefulPolicyPreservedStateDiskDevice": {
"id": "StatefulPolicyPreservedStateDiskDevice",
"properties": {
"autoDelete": {
"description": "These stateful disks will never be deleted during autohealing,\nupdate or VM instance recreate operations.\nThis flag is used to configure if the disk should be deleted after it\nis no longer used by the group, e.g. when the given instance or\nthe whole group is deleted. Note: disks attached inREAD_ONLY mode cannot be auto-deleted.",
"enum": [
"NEVER",
"ON_PERMANENT_INSTANCE_DELETION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"StatefulPolicyPreservedStateNetworkIp": {
"id": "StatefulPolicyPreservedStateNetworkIp",
"properties": {
"autoDelete": {
"description": "These stateful IPs will never be released during autohealing,\nupdate or VM instance recreate operations.\nThis flag is used to configure if the IP reservation should be deleted\nafter it is no longer used by the group, e.g. when the given instance\nor the whole group is deleted.",
"enum": [
"NEVER",
"ON_PERMANENT_INSTANCE_DELETION"
],
"enumDescriptions": [
"",
""
],
"type": "string"
}
},
"type": "object"
},
"Status": {
"description": "The `Status` type defines a logical error model that is suitable for\ndifferent programming environments, including REST APIs and RPC APIs. It is\nused by [gRPC](https://github.com/grpc). Each `Status` message contains\nthree pieces of data: error code, error message, and error details.\n\nYou can find out more about this error model and how to work with it in the\n[API Design Guide](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details.  There is a common set of\nmessage types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"format": "google.protobuf.Any",
"type": "object"
},
"type": "array"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"type": "object"
},
"StoragePool": {
"description": "Represents a zonal storage pool resource.",
"id": "StoragePool",
"properties": {
"capacityProvisioningType": {
"description": "Provisioning type of the byte capacity of the pool.",
"enum": [
"ADVANCED",
"STANDARD",
"UNSPECIFIED"
],
"enumDescriptions": [
"Advanced provisioning \"thinly\" allocates the related resource.",
"Standard provisioning allocates the related resource for the pool\ndisks' exclusive use.",
""
],
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"exapoolProvisionedCapacityGb": {
"$ref": "StoragePoolExapoolProvisionedCapacityGb",
"description": "Output only. [Output Only] Provisioned capacities for each SKU for this Exapool in GiB",
"readOnly": true
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#storagePool",
"description": "Output only. [Output Only] Type of the resource. Always compute#storagePool\nfor storage pools.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this storage pool, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a storage pool.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels to apply to this storage pool. These can be later modified by\nthe setLabels method.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.storagePools.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "StoragePoolParams",
"description": "Input only. Additional params passed with the request, but not persisted\nas part of resource payload."
},
"performanceProvisioningType": {
"description": "Provisioning type of the performance-related parameters of the pool,\nsuch as throughput and IOPS.",
"enum": [
"ADVANCED",
"STANDARD",
"UNSPECIFIED"
],
"enumDescriptions": [
"Advanced provisioning \"thinly\" allocates the related resource.",
"Standard provisioning allocates the related resource for the pool\ndisks' exclusive use.",
""
],
"type": "string"
},
"poolProvisionedCapacityGb": {
"annotations": {
"required": [
"compute.storagePools.insert"
]
},
"description": "Size of the storage pool in GiB. For more information about the size\nlimits, see https://cloud.google.com/compute/docs/disks/storage-pools.",
"format": "int64",
"type": "string"
},
"poolProvisionedIops": {
"description": "Provisioned IOPS of the storage pool. Only relevant if the storage pool\ntype is hyperdisk-balanced.",
"format": "int64",
"type": "string"
},
"poolProvisionedThroughput": {
"description": "Provisioned throughput of the storage pool in MiB/s. Only relevant if the\nstorage pool type is hyperdisk-balanced or hyperdisk-throughput.",
"format": "int64",
"type": "string"
},
"resourceStatus": {
"$ref": "StoragePoolResourceStatus",
"description": "Output only. [Output Only] Status information for the storage pool resource.",
"readOnly": true
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. [Output Only] The status of storage pool creation.\n   \n   \n     - CREATING: Storage pool is provisioning.\n     storagePool.\n     - FAILED: Storage pool creation failed.\n     - READY: Storage pool is ready for use.\n     - DELETING: Storage pool is deleting.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY"
],
"enumDescriptions": [
"StoragePool is provisioning",
"StoragePool is deleting.",
"StoragePool creation failed.",
"StoragePool is ready for use."
],
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "StoragePoolResourceStatus",
"description": "Output only. [Output Only] Status information for the storage pool resource.",
"readOnly": true
},
"storagePoolType": {
"description": "Type of the storage pool.",
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the storage pool resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"StoragePoolAggregatedList": {
"id": "StoragePoolAggregatedList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "StoragePoolsScopedList",
"description": "[Output Only] Name of the scope containing this set of storage pool."
},
"description": "A list of StoragePoolsScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#storagePoolAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#storagePoolAggregatedList for aggregated lists of\nstorage pools.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"StoragePoolDisk": {
"id": "StoragePoolDisk",
"properties": {
"attachedInstances": {
"description": "Output only. [Output Only] Instances this disk is attached to.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"disk": {
"description": "Output only. [Output Only] The URL of the disk.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Output only. [Output Only] The name of the disk.",
"readOnly": true,
"type": "string"
},
"provisionedIops": {
"description": "Output only. [Output Only] The number of IOPS provisioned for the disk.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"provisionedThroughput": {
"description": "Output only. [Output Only] The throughput provisioned for the disk.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"resourcePolicies": {
"description": "Output only. [Output Only] Resource policies applied to disk for automatic snapshot\ncreations.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"sizeGb": {
"description": "Output only. [Output Only] The disk size, in GB.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"status": {
"description": "Output only. [Output Only] The disk status.",
"enum": [
"CREATING",
"DELETING",
"FAILED",
"READY",
"RESTORING",
"UNAVAILABLE"
],
"enumDescriptions": [
"Disk is provisioning",
"Disk is deleting.",
"Disk creation failed.",
"Disk is ready for use.",
"Source data is being copied into the disk.",
"Disk is currently unavailable and cannot be accessed, attached or\ndetached."
],
"readOnly": true,
"type": "string"
},
"type": {
"description": "Output only. [Output Only] The disk type.",
"readOnly": true,
"type": "string"
},
"usedBytes": {
"description": "Output only. [Output Only] Amount of disk space used.",
"format": "int64",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"StoragePoolExapoolProvisionedCapacityGb": {
"description": "Exapool provisioned capacities for each SKU type",
"id": "StoragePoolExapoolProvisionedCapacityGb",
"properties": {
"capacityOptimized": {
"description": "Size, in GiB, of provisioned capacity-optimized capacity for this Exapool",
"format": "int64",
"type": "string"
},
"readOptimized": {
"description": "Size, in GiB, of provisioned read-optimized capacity for this Exapool",
"format": "int64",
"type": "string"
},
"writeOptimized": {
"description": "Size, in GiB, of provisioned write-optimized capacity for this Exapool",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"StoragePoolList": {
"description": "A list of StoragePool resources.",
"id": "StoragePoolList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of StoragePool resources.",
"items": {
"$ref": "StoragePool"
},
"type": "array"
},
"kind": {
"default": "compute#storagePoolList",
"description": "Output only. [Output Only] Type of resource. Always compute#storagePoolList\nfor lists of storagePools.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"StoragePoolListDisks": {
"id": "StoragePoolListDisks",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "A list of StoragePoolDisk resources.",
"items": {
"$ref": "StoragePoolDisk"
},
"type": "array"
},
"kind": {
"default": "compute#storagePoolListDisks",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#storagePoolListDisks for lists of disks in a\nstoragePool.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"type": "object"
}
},
"type": "object"
},
"StoragePoolParams": {
"description": "Additional storage pool params.",
"id": "StoragePoolParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Input only. Resource manager tags to be bound to the storage pool. Tag keys and values\nhave the same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
"type": "object"
}
},
"type": "object"
},
"StoragePoolResourceStatus": {
"description": "[Output Only] Contains output only fields.",
"id": "StoragePoolResourceStatus",
"properties": {
"diskCount": {
"description": "[Output Only] Number of disks used.",
"format": "int64",
"type": "string"
},
"exapoolMaxReadIops": {
"description": "Output only. [Output Only] Maximum allowed read IOPS for this Exapool.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"exapoolMaxReadThroughput": {
"description": "Output only. [Output Only] Maximum allowed read throughput in MiB/s for\nthis Exapool.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"exapoolMaxWriteIops": {
"description": "Output only. [Output Only] Maximum allowed write IOPS for this Exapool.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"exapoolMaxWriteThroughput": {
"description": "Output only. [Output Only] Maximum allowed write throughput in MiB/s\nfor this Exapool.",
"format": "int64",
"readOnly": true,
"type": "string"
},
"lastResizeTimestamp": {
"description": "Output only. [Output Only] Timestamp of the last successful resize inRFC3339 text format.",
"readOnly": true,
"type": "string"
},
"maxTotalProvisionedDiskCapacityGb": {
"description": "[Output Only] Maximum allowed aggregate disk size in GiB.",
"format": "int64",
"type": "string"
},
"poolUsedCapacityBytes": {
"description": "[Output Only] Space used by data stored in disks within the storage pool\n(in bytes). This will reflect the total number of bytes written to the\ndisks in the pool, in contrast to the capacity of those disks.",
"format": "int64",
"type": "string"
},
"poolUsedIops": {
"description": "[Output Only] Sum of all the disks' provisioned IOPS, minus some amount\nthat is allowed per disk that is not counted towards pool's IOPS\ncapacity. For more information, see\nhttps://cloud.google.com/compute/docs/disks/storage-pools.",
"format": "int64",
"type": "string"
},
"poolUsedThroughput": {
"description": "[Output Only] Sum of all the disks' provisioned throughput in MiB/s.",
"format": "int64",
"type": "string"
},
"poolUserWrittenBytes": {
"description": "[Output Only] Amount of data written into the pool, before it is\ncompacted.",
"format": "int64",
"type": "string"
},
"totalProvisionedDiskCapacityGb": {
"description": "[Output Only] Sum of all the disks' provisioned capacity (in GiB) in\nthis storage pool. A disk's provisioned capacity is the same as its total\ncapacity.",
"format": "int64",
"type": "string"
},
"totalProvisionedDiskIops": {
"description": "[Output Only] Sum of all the disks' provisioned IOPS.",
"format": "int64",
"type": "string"
},
"totalProvisionedDiskThroughput": {
"description": "[Output Only] Sum of all the disks' provisioned throughput in MiB/s,\nminus some amount that is allowed per disk that is not counted towards\npool's throughput capacity.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"StoragePoolType": {
"id": "StoragePoolType",
"properties": {
"creationTimestamp": {
"description": "[Output Only] Creation timestamp inRFC3339\ntext format.",
"type": "string"
},
"deprecated": {
"$ref": "DeprecationStatus",
"description": "[Output Only] The deprecation status associated with this storage pool\ntype."
},
"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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#storagePoolType",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#storagePoolType for storage pool types.",
"readOnly": true,
"type": "string"
},
"maxPoolProvisionedCapacityGb": {
"description": "[Output Only] Maximum storage pool size in GB.",
"format": "int64",
"type": "string"
},
"maxPoolProvisionedIops": {
"description": "[Output Only] Maximum provisioned IOPS.",
"format": "int64",
"type": "string"
},
"maxPoolProvisionedThroughput": {
"description": "[Output Only] Maximum provisioned throughput.",
"format": "int64",
"type": "string"
},
"minPoolProvisionedCapacityGb": {
"description": "[Output Only] Minimum storage pool size in GB.",
"format": "int64",
"type": "string"
},
"minPoolProvisionedIops": {
"description": "[Output Only] Minimum provisioned IOPS.",
"format": "int64",
"type": "string"
},
"minPoolProvisionedThroughput": {
"description": "[Output Only] Minimum provisioned throughput.",
"format": "int64",
"type": "string"
},
"minSizeGb": {
"description": "[Deprecated] This field is deprecated. Use minPoolProvisionedCapacityGb\ninstead.",
"format": "int64",
"type": "string"
},
"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"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource with the resource id.",
"readOnly": true,
"type": "string"
},
"supportedDiskTypes": {
"description": "[Output Only] The list of disk types supported in this storage pool type.",
"items": {
"type": "string"
},
"type": "array"
},
"zone": {
"description": "[Output Only] URL of the zone where the storage pool type resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"type": "string"
}
},
"type": "object"
},
"StoragePoolTypeAggregatedList": {
"id": "StoragePoolTypeAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "StoragePoolTypesScopedList",
"description": "[Output Only] Name of the scope containing this set of storage pool types."
},
"description": "A list of StoragePoolTypesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#storagePoolTypeAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#storagePoolTypeAggregatedList.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"StoragePoolTypeList": {
"description": "Contains a list of storage pool types.",
"id": "StoragePoolTypeList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of StoragePoolType resources.",
"items": {
"$ref": "StoragePoolType"
},
"type": "array"
},
"kind": {
"default": "compute#storagePoolTypeList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#storagePoolTypeList for storage pool types.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"StoragePoolTypesScopedList": {
"id": "StoragePoolTypesScopedList",
"properties": {
"storagePoolTypes": {
"description": "[Output Only] A list of storage pool types contained in this scope.",
"items": {
"$ref": "StoragePoolType"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of storage pool\ntypes when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"StoragePoolsScopedList": {
"id": "StoragePoolsScopedList",
"properties": {
"storagePools": {
"description": "[Output Only] A list of storage pool contained in this scope.",
"items": {
"$ref": "StoragePool"
},
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning which replaces the list of storage pool\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"Subnetwork": {
"description": "Represents a Subnetwork resource.\n\nA subnetwork (also known as a subnet) is a logical partition of a Virtual\nPrivate Cloud network with one primary IP range and zero or more secondary\nIP ranges. For more information, read\nVirtual Private Cloud (VPC) Network.",
"id": "Subnetwork",
"properties": {
"allowSubnetCidrRoutesOverlap": {
"description": "Whether this subnetwork's ranges can conflict with existing custom routes.\nSetting this to true allows this subnetwork's primary and secondary ranges\nto overlap with (and contain) custom routes that have already been\nconfigured on the corresponding network.\n\nFor example if a static route has range 10.1.0.0/16, a subnet\nrange 10.0.0.0/8 could only be created if allow_conflicting_routes=true.\n\nOverlapping is only allowed on subnetwork operations; routes\nwhose ranges conflict with this subnetwork's ranges won't be allowed unless\nroute.allow_conflicting_subnetworks is set to true.\n\nTypically packets destined to IPs within the subnetwork (which may contain\nprivate/sensitive data) are prevented from leaving the virtual network.\nSetting this field to true will disable this feature.\n\nThe default value is false and applies to all existing subnetworks and\nautomatically created subnetworks.",
"type": "boolean"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate 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\nexplicitly set, it will not appear in get listings. If not set\nthe default behavior is determined by the org policy, if there is no org\npolicy specified, then it will default to disabled. This field isn't\nsupported if the subnet purpose field is set toREGIONAL_MANAGED_PROXY. It is recommended to uselogConfig.enable field instead.",
"type": "boolean"
},
"externalIpv6Prefix": {
"description": "The external IPv6 address range that is owned by this\nsubnetwork.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a Subnetwork. An up-to-date fingerprint must be\nprovided in order to update the Subnetwork, otherwise the\nrequest will fail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a Subnetwork.",
"format": "byte",
"type": "string"
},
"gatewayAddress": {
"description": "Output only. [Output Only] The gateway address for default routes to reach destination\naddresses outside this subnetwork.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"internalIpv6Prefix": {
"description": "The internal IPv6 address range that is owned by this\nsubnetwork.",
"type": "string"
},
"ipCidrRange": {
"description": "The range of internal addresses that are owned by this subnetwork.\nProvide this property when you create the subnetwork. For example,10.0.0.0/8 or 100.64.0.0/10. Ranges must\nbe unique and non-overlapping within a network. Only IPv4 is supported.\nThis field is set at resource creation time. The range can be any range\nlisted in theValid\nranges list. The range can be expanded after creation usingexpandIpCidrRange.",
"type": "string"
},
"ipCollection": {
"description": "Reference to the source of IP, like a PublicDelegatedPrefix\n(PDP) for BYOIP. The PDP must be a sub-PDP in\nEXTERNAL_IPV6_SUBNETWORK_CREATION or INTERNAL_IPV6_SUBNETWORK_CREATION\nmode.\n\nUse one of the following formats to specify a sub-PDP when creating a dual\nstack or IPv6-only subnetwork with external access using BYOIP:\n   \n   - \n   Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name\n   - \n   Partial URL, as in\n     \n      \n          - projects/projectId/regions/region/publicDelegatedPrefixes/sub-pdp-name\n          - regions/region/publicDelegatedPrefixes/sub-pdp-name",
"type": "string"
},
"ipv6AccessType": {
"description": "The access type of IPv6 address this subnet holds. It's immutable and can\nonly be specified during creation or the first time the subnet is updated\ninto IPV4_IPV6 dual stack.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"VMs on this subnet will be assigned IPv6 addresses that are accessible\nvia the Internet, as well as the VPC network.",
"VMs on this subnet will be assigned IPv6 addresses that are only\naccessible over the VPC network."
],
"type": "string"
},
"ipv6CidrRange": {
"description": "Output only. [Output Only] This field is for internal use.",
"readOnly": true,
"type": "string"
},
"ipv6GceEndpoint": {
"description": "Output only. [Output Only] Possible endpoints of this subnetwork. It can be one of the\nfollowing:\n   \n   - VM_ONLY: The subnetwork can be used for creating instances and\n   IPv6 addresses with VM endpoint type. Such a subnetwork gets external IPv6\n   ranges from a public delegated prefix and cannot be used to create NetLb.\n   - VM_AND_FR: The subnetwork can be used for creating both VM\n   instances and Forwarding Rules. It can also be used to reserve IPv6\n   addresses with both VM and FR endpoint types. Such a subnetwork gets its\n   IPv6 range from Google IP Pool directly.",
"enum": [
"VM_AND_FR",
"VM_ONLY"
],
"enumDescriptions": [
"",
""
],
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#subnetwork",
"description": "Output only. [Output Only] Type of the resource. Always compute#subnetwork\nfor Subnetwork resources.",
"readOnly": true,
"type": "string"
},
"logConfig": {
"$ref": "SubnetworkLogConfig",
"description": "This field denotes the VPC flow logging options for this subnetwork.\nIf logging is enabled, logs are exported to Cloud Logging."
},
"name": {
"description": "The name of the resource, provided by the client when initially creating\nthe resource. The name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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\nclient when initially creating the subnetwork. This field can be set only\nat resource creation time.",
"type": "string"
},
"params": {
"$ref": "SubnetworkParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"privateIpGoogleAccess": {
"description": "Whether the VMs in this subnet can access Google services without assigned\nexternal IP addresses. This field can be both set at resource creation\ntime and updated using setPrivateIpGoogleAccess.",
"type": "boolean"
},
"privateIpv6GoogleAccess": {
"description": "This field is for internal use.\n\nThis field can be both set at resource creation time and updated usingpatch.",
"enum": [
"DISABLE_GOOGLE_ACCESS",
"ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE",
"ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE"
],
"enumDescriptions": [
"Disable private IPv6 access to/from Google services.",
"Bidirectional private IPv6 access to/from Google services.",
"Outbound private IPv6 access from VMs in this subnet to Google services."
],
"type": "string"
},
"purpose": {
"enum": [
"GLOBAL_MANAGED_PROXY",
"INTERNAL_HTTPS_LOAD_BALANCER",
"PEER_MIGRATION",
"PRIVATE",
"PRIVATE_NAT",
"PRIVATE_RFC_1918",
"PRIVATE_SERVICE_CONNECT",
"REGIONAL_MANAGED_PROXY"
],
"enumDescriptions": [
"Subnet reserved for Global Envoy-based Load Balancing.",
"Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy\npurpose, please use REGIONAL_MANAGED_PROXY instead.",
"Subnetwork will be used for Migration from one peered VPC to another.\n(a transient state of subnetwork\nwhile migrating resources from one project to another).",
"Regular user created or automatically created subnet.",
"Subnetwork used as source range for Private NAT Gateways.",
"Regular user created or automatically created subnet.",
"Subnetworks created for Private Service Connect in the producer network.",
"Subnetwork used for Regional Envoy-based Load Balancing."
],
"type": "string"
},
"region": {
"description": "URL of the region where the Subnetwork resides. This\nfield can be set only at resource creation time.",
"type": "string"
},
"reservedInternalRange": {
"description": "The URL of the reserved internal range.",
"type": "string"
},
"resolveSubnetMask": {
"description": "Configures subnet mask resolution for this subnetwork.",
"enum": [
"ARP_ALL_RANGES",
"ARP_PRIMARY_RANGE"
],
"enumDescriptions": [
"All ranges assigned to the VM NIC will respond to ARP.",
"Only the primary range of the VM NIC will respond to ARP."
],
"type": "string"
},
"role": {
"description": "The role of subnetwork. Currently, this field is only used when\npurpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE\nsubnetwork is one that is currently being used for Envoy-based load\nbalancers in a region. A BACKUP subnetwork is one that is\nready to be promoted to ACTIVE or is currently draining.\nThis field can be updated with a patch request.",
"enum": [
"ACTIVE",
"BACKUP"
],
"enumDescriptions": [
"The ACTIVE subnet that is currently used.",
"The BACKUP subnet that could be promoted to ACTIVE."
],
"type": "string"
},
"secondaryIpRanges": {
"description": "An array of configurations for secondary IP ranges for VM instances\ncontained in this subnetwork. The primary IP of such VM must belong to the\nprimary ipCidrRange of the subnetwork. The alias IPs may belong to either\nprimary or secondary ranges. This field can be updated with apatch request. Supports both IPv4 and IPv6 ranges.",
"items": {
"$ref": "SubnetworkSecondaryRange"
},
"type": "array"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"stackType": {
"description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs\nin the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and\nIPv6 addresses. If not specified, IPV4_ONLY is used.\n\nThis field can be both set at resource creation time and updated usingpatch.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY",
"IPV6_ONLY"
],
"enumDescriptions": [
"New VMs in this subnet can have both IPv4 and IPv6 addresses.",
"New VMs in this subnet will only be assigned IPv4 addresses.",
"New VMs in this subnet will only  be assigned IPv6 addresses."
],
"type": "string"
},
"state": {
"description": "Output only. [Output Only] The state of the subnetwork, which can be one of the\nfollowing values:READY: Subnetwork is created and ready to useDRAINING: only applicable to subnetworks that have the\npurpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that\nconnections to the load balancer are being drained. A subnetwork that is\ndraining cannot be used or modified until it reaches a status ofREADY",
"enum": [
"DRAINING",
"READY"
],
"enumDescriptions": [
"Subnetwork is being drained.",
"Subnetwork is ready for use."
],
"readOnly": true,
"type": "string"
},
"systemReservedExternalIpv6Ranges": {
"description": "Output only. [Output Only] The array of external IPv6 network ranges reserved from\nthe subnetwork's external IPv6 range for system use.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"systemReservedInternalIpv6Ranges": {
"description": "Output only. [Output Only] The array of internal IPv6 network ranges reserved from\nthe subnetwork's internal IPv6 range for system use.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"utilizationDetails": {
"$ref": "SubnetworkUtilizationDetails",
"description": "Output only. [Output Only] The current IP utilization of all subnetwork ranges. Contains\nthe total number of allocated and free IPs in each range.",
"readOnly": true
}
},
"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. [Output Only] Type of resource. Alwayscompute#subnetworkAggregatedList for aggregated lists of\nsubnetworks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#subnetworkList\nfor lists of subnetworks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nToggles the aggregation interval for collecting flow logs. Increasing the\ninterval time will reduce the amount of generated flow logs for long\nlasting 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\nexplicitly set, it will not appear in get listings. If not\nset the default behavior is determined by the org policy, if there is no\norg policy specified, then it will default to disabled.\nFlow logging isn't supported if the subnet purpose field is\nset to REGIONAL_MANAGED_PROXY.",
"type": "boolean"
},
"filterExpr": {
"description": "Can only be specified if VPC flow logs for this subnetwork is enabled.\nThe filter expression is used to define which VPC flow logs should be\nexported to Cloud Logging.",
"type": "string"
},
"flowSampling": {
"description": "Can only be specified if VPC flow logging for this subnetwork is enabled.\nThe value of the field must be in [0, 1]. Set the sampling rate of VPC\nflow logs within the subnetwork where 1.0 means all collected logs are\nreported and 0.0 means no logs are reported. Default is 0.5 unless\notherwise specified by the org policy, which means half of all collected\nlogs are reported.",
"format": "float",
"type": "number"
},
"metadata": {
"description": "Can only be specified if VPC flow logs for this subnetwork is enabled.\nConfigures whether all, none or a subset of metadata fields should be\nadded to the reported VPC flow logs. Default isEXCLUDE_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\n\"metadata\" was set to CUSTOM_METADATA.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SubnetworkParams": {
"description": "Additional subnetwork parameters.",
"id": "SubnetworkParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.",
"type": "object"
}
},
"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.\nProvide this property when you create the subnetwork. Ranges must be\nunique and non-overlapping with all primary and secondary IP ranges\nwithin a network. Both IPv4 and IPv6 ranges are supported. For IPv4,\nthe range can be any range listed in theValid\nranges list.\n\nFor IPv6:\nThe range must have a /64 prefix length.\nThe range must be omitted, for auto-allocation from Google-defined ULA\nIPv6 range.\nFor BYOGUA internal IPv6 secondary range, the range may be specified\nalong with the `ipCollection` field.\nIf an `ipCollection` is specified, the requested ip_cidr_range must lie\nwithin the range of the PDP referenced by the `ipCollection` field for\nallocation.\nIf `ipCollection` field is specified, but ip_cidr_range is not,\nthe range is auto-allocated from the PDP referenced by the `ipCollection`\nfield.",
"type": "string"
},
"rangeName": {
"description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP/IPv6 range to a VM instance.\nThe name must be 1-63 characters long, and comply withRFC1035.\nThe name must be unique within the subnetwork.",
"type": "string"
},
"reservedInternalRange": {
"description": "The URL of the reserved internal range. Only IPv4 is supported.",
"type": "string"
}
},
"type": "object"
},
"SubnetworkUtilizationDetails": {
"description": "The current IP utilization of all subnetwork ranges. Contains the total\nnumber of allocated and free IPs in each range.",
"id": "SubnetworkUtilizationDetails",
"properties": {
"externalIpv6InstanceUtilization": {
"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
"description": "Utilizations of external IPV6 IP range."
},
"externalIpv6LbUtilization": {
"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
"description": "Utilizations of external IPV6 IP range for NetLB."
},
"internalIpv6Utilization": {
"$ref": "SubnetworkUtilizationDetailsIPV6Utilization",
"description": "Utilizations of internal IPV6 IP range."
},
"ipv4Utilizations": {
"description": "Utilizations of all IPV4 IP ranges. For primary ranges, the range name\nwill be empty.",
"items": {
"$ref": "SubnetworkUtilizationDetailsIPV4Utilization"
},
"type": "array"
}
},
"type": "object"
},
"SubnetworkUtilizationDetailsIPV4Utilization": {
"description": "The IPV4 utilization of a single IP range.",
"id": "SubnetworkUtilizationDetailsIPV4Utilization",
"properties": {
"rangeName": {
"description": "Will be set for secondary range. Empty for primary IPv4 range.",
"type": "string"
},
"totalAllocatedIp": {
"format": "int64",
"type": "string"
},
"totalFreeIp": {
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"SubnetworkUtilizationDetailsIPV6Utilization": {
"description": "The IPV6 utilization of a single IP range.",
"id": "SubnetworkUtilizationDetailsIPV6Utilization",
"properties": {
"totalAllocatedIp": {
"$ref": "Uint128"
},
"totalFreeIp": {
"$ref": "Uint128"
}
},
"type": "object"
},
"SubnetworksExpandIpCidrRangeRequest": {
"id": "SubnetworksExpandIpCidrRangeRequest",
"properties": {
"ipCidrRange": {
"description": "The IP (in CIDR format or netmask) of internal addresses that are legal on\nthis Subnetwork. This range should be disjoint from other subnetworks\nwithin this network. This range can only be larger than (i.e. a superset\nof) 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\nis empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"SubnetworksScopedWarning": {
"id": "SubnetworksScopedWarning",
"properties": {
"scopeName": {
"description": "Name of the scope containing this set of Subnetworks.",
"type": "string"
},
"warning": {
"description": "An informational warning about unreachable scope",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"Subsetting": {
"description": "Subsetting configuration for this BackendService.\nCurrently this is applicable only for Internal TCP/UDP load balancing,\nInternal HTTP(S) load balancing and Traffic Director.",
"id": "Subsetting",
"properties": {
"policy": {
"enum": [
"CONSISTENT_HASH_SUBSETTING",
"NONE"
],
"enumDescriptions": [
"Subsetting based on consistent hashing.\n\nFor Traffic Director, the number of backends per backend group\n(the subset size) is based on the `subset_size` parameter.\n\nFor Internal HTTP(S) load balancing, the number of backends per backend\ngroup (the subset size) is dynamically adjusted in two cases:\n- As the number of proxy instances participating in Internal HTTP(S) load\n  balancing increases, the subset size decreases.\n- When the total number of backends in a network exceeds the capacity of\n  a single proxy instance, subset sizes are reduced automatically for\n  each service that has backend subsetting enabled.",
"No Subsetting.\n\nClients may open connections and send traffic to all backends of this\nbackend service. This can lead to performance issues if there is\nsubstantial imbalance in the count of clients and backends."
],
"type": "string"
}
},
"type": "object"
},
"TCPHealthCheck": {
"id": "TCPHealthCheck",
"properties": {
"port": {
"description": "The TCP port number to which the health check prober sends packets. The\ndefault value is 80. Valid values are 1 through65535.",
"format": "int32",
"type": "integer"
},
"portName": {
"description": "Not supported.",
"type": "string"
},
"portSpecification": {
"description": "Specifies how a port is selected for health checking. Can be one of the\nfollowing values: \nUSE_FIXED_PORT: Specifies a port number explicitly using theport field  in the health check. Supported by backend services\nfor passthrough load balancers and backend services for proxy load\nbalancers. Not supported by target pools. The health check supports all\nbackends supported by the backend service provided the backend can be\nhealth checked. For example, GCE_VM_IP network endpoint\ngroups, GCE_VM_IP_PORT network endpoint groups, and instance\ngroup backends. \nUSE_NAMED_PORT: Not supported. \nUSE_SERVING_PORT: Provides an indirect method of specifying\nthe health check port by referring to the backend service. Only supported\nby backend services for proxy load balancers. Not supported by target\npools.  Not supported by backend services for passthrough load balancers.\nSupports all backends that can be health checked; for example,GCE_VM_IP_PORT network endpoint groups and instance group\nbackends.\n\nFor GCE_VM_IP_PORT network endpoint group backends, the health\ncheck uses the port number specified for each endpoint in the network\nendpoint group.  For instance group backends, the health check uses the\nport number determined by looking up the backend service's named port in\nthe instance group's list of named ports.",
"enum": [
"USE_FIXED_PORT",
"USE_NAMED_PORT",
"USE_SERVING_PORT"
],
"enumDescriptions": [
"The port number in the health check's port is used for health\nchecking. Applies to network endpoint group and instance group backends.",
"Not supported.",
"For network endpoint group backends, the health check uses the port number\nspecified on each endpoint in the network endpoint group. For instance\ngroup backends, the health check uses the port number specified for the\nbackend service's named port defined in the instance group's named ports."
],
"type": "string"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"request": {
"description": "Instructs the health check prober to send this exact ASCII string, up to\n1024 bytes in length, after establishing the TCP connection.",
"type": "string"
},
"response": {
"description": "Creates a content-based TCP health check. In addition to establishing a\nTCP connection, you can configure the health check to pass only when the\nbackend sends this exact response ASCII string, up to 1024 bytes in length.\nFor details, see:\nhttps://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp",
"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\nthe tags' contents and used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update tags. You must always provide an\nup-to-date fingerprint hash in order to update or change tags.\n\nTo see the latest fingerprint, make get() request to the\ninstance.",
"format": "byte",
"type": "string"
},
"items": {
"description": "An array of tags. Each tag must be 1-63 characters long, and comply\nwith RFC1035.",
"items": {
"type": "string"
},
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "array"
}
},
"type": "object"
},
"TargetGrpcProxy": {
"description": "Represents a Target gRPC Proxy resource.\n\nA target gRPC proxy is a component of load balancers intended for\nload balancing gRPC traffic. Only global forwarding rules with load balancing\nscheme INTERNAL_SELF_MANAGED can reference a target gRPC proxy. The target\ngRPC Proxy references a URL map that specifies how traffic is routed to\ngRPC backend services.",
"id": "TargetGrpcProxy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a TargetGrpcProxy. An up-to-date fingerprint must\nbe provided in order to patch/update the TargetGrpcProxy; otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nTargetGrpcProxy.",
"format": "byte",
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#targetGrpcProxy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#targetGrpcProxy for target grpc proxies.",
"readOnly": true,
"type": "string"
},
"name": {
"annotations": {
"required": [
"compute.targetGrpcProxies.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL with id for the resource.",
"readOnly": true,
"type": "string"
},
"urlMap": {
"description": "URL to the UrlMap resource that defines the mapping from URL to the\nBackendService. The protocol field in the BackendService must be set to\nGRPC.",
"type": "string"
},
"validateForProxyless": {
"description": "If true, indicates that the BackendServices referenced by the urlMap may be\naccessed by gRPC applications without using a sidecar proxy. This will\nenable configuration checks on urlMap and its referenced BackendServices to\nnot allow unsupported features. A gRPC application must use\n\"xds:///\" scheme in the target URI of the service it is\nconnecting to.\nIf false, indicates that the BackendServices referenced by the urlMap will\nbe accessed by gRPC applications via a sidecar proxy. In this case, a gRPC\napplication must not use \"xds:///\" scheme in the target URI of\nthe service it is connecting to",
"type": "boolean"
}
},
"type": "object"
},
"TargetGrpcProxyList": {
"id": "TargetGrpcProxyList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of TargetGrpcProxy resources.",
"items": {
"$ref": "TargetGrpcProxy"
},
"type": "array"
},
"kind": {
"default": "compute#targetGrpcProxyList",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#targetGrpcProxy for target grpc proxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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/v1/targetHttpProxies)\n* [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies)\n\nA target HTTP proxy is a component of Google Cloud HTTP load balancers.\n\n* targetHttpProxies are used by global external Application Load Balancers,\n  classic Application Load Balancers, cross-region internal Application Load\n  Balancers, and Traffic Director.\n* regionTargetHttpProxies are used by regional internal Application Load\n  Balancers and regional external Application Load Balancers.\n\nForwarding rules reference a target HTTP proxy, and the target proxy\nthen references a URL map. For more information, readUsing Target Proxies\nand \nForwarding rule concepts.",
"id": "TargetHttpProxy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a TargetHttpProxy. An up-to-date fingerprint must\nbe provided in order to patch/update the TargetHttpProxy; otherwise, the\nrequest will fail with error 412 conditionNotMet. To see the\nlatest fingerprint, make a get() request to retrieve the\nTargetHttpProxy.",
"format": "byte",
"type": "string"
},
"httpKeepAliveTimeoutSec": {
"description": "Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keep-alive is\nnot specified, a default value (610 seconds) will be used.\n\nFor global external Application Load Balancers, the minimum allowed value\nis 5 seconds and the maximum allowed value is 1200 seconds.\n\nFor classic Application Load Balancers, this option is not supported.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetHttpProxy",
"description": "Output only. [Output Only] Type of resource. Always compute#targetHttpProxy\nfor target HTTP proxies.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"proxyBind": {
"description": "This field only applies when the forwarding rule that references this\ntarget proxy has a loadBalancingScheme set toINTERNAL_SELF_MANAGED.\n\nWhen this field is set to true, Envoy proxies set up inbound\ntraffic interception and bind to the IP address and port specified in the\nforwarding rule. This is generally useful when using Traffic Director to\nconfigure Envoy as a gateway or middle proxy (in other words, not a\nsidecar proxy). The Envoy proxy listens for inbound requests and handles\nrequests when it receives them.\n\nThe default is false.",
"type": "boolean"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional Target HTTP Proxy\nresides. This field is not applicable to global Target HTTP Proxies.",
"readOnly": true,
"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\nthe 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. [Output Only] Type of resource. Alwayscompute#targetHttpProxyAggregatedList for lists of Target HTTP\nProxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"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": "Output only. Type of resource. Always compute#targetHttpProxyList for lists\nof target HTTP proxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"TargetHttpsProxiesSetCertificateMapRequest": {
"id": "TargetHttpsProxiesSetCertificateMapRequest",
"properties": {
"certificateMap": {
"description": "URL of the Certificate Map to associate with this TargetHttpsProxy.\n\n Accepted format is//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}.",
"type": "string"
}
},
"type": "object"
},
"TargetHttpsProxiesSetQuicOverrideRequest": {
"id": "TargetHttpsProxiesSetQuicOverrideRequest",
"properties": {
"quicOverride": {
"description": "QUIC policy for the TargetHttpsProxy resource.",
"enum": [
"DISABLE",
"ENABLE",
"NONE"
],
"enumDescriptions": [
"The load balancer will not attempt to negotiate QUIC with clients.",
"The load balancer will attempt to negotiate QUIC with clients.",
"No overrides to the default QUIC policy. This option is implicit if\nno QUIC override has been specified in the request."
],
"type": "string"
}
},
"type": "object"
},
"TargetHttpsProxiesSetSslCertificatesRequest": {
"id": "TargetHttpsProxiesSetSslCertificatesRequest",
"properties": {
"sslCertificates": {
"description": "New set of SslCertificate resources to associate\nwith this TargetHttpsProxy resource. At least one SSL\ncertificate must be specified. Currently, you may specify up to 15 SSL\ncertificates.",
"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/v1/targetHttpsProxies)\n* [Regional](/compute/docs/reference/rest/v1/regionTargetHttpsProxies)\n\nA target HTTPS proxy is a component of Google Cloud HTTPS load balancers.\n\n* targetHttpsProxies are used by global external Application Load Balancers,\n  classic Application Load Balancers, cross-region internal Application Load\n  Balancers, and Traffic Director.\n* regionTargetHttpsProxies are used by regional internal Application Load\n  Balancers and regional external Application Load Balancers.\n\nForwarding rules reference a target HTTPS proxy, and the target proxy\nthen references a URL map. For more information, readUsing Target Proxies\nand \nForwarding rule concepts.",
"id": "TargetHttpsProxy",
"properties": {
"authorizationPolicy": {
"description": "Optional. A URL referring to a networksecurity.AuthorizationPolicy resource\nthat describes how the proxy should authorize inbound traffic. If left\nblank, access will not be restricted by an authorization policy.\n\n Refer to the AuthorizationPolicy resource for additional\ndetails.\n\n authorizationPolicy only applies to a globalTargetHttpsProxy attached toglobalForwardingRules with theloadBalancingScheme set to INTERNAL_SELF_MANAGED.\n\n Note: This field currently has no impact.",
"type": "string"
},
"certificateMap": {
"description": "URL of a certificate map that identifies a certificate map associated with\nthe given target proxy.\nThis field can only be set for Global external Application Load Balancer or\nClassic Application Load Balancer. For other products use Certificate\nManager Certificates instead.\n\nIf set, sslCertificates will be ignored.\n\n Accepted format is//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}.",
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field will be ignored when\ninserting a TargetHttpsProxy. An up-to-date fingerprint must\nbe provided in order to patch the TargetHttpsProxy; otherwise, the request\nwill fail with error 412 conditionNotMet. To see the latest\nfingerprint, make a get() request to retrieve the\nTargetHttpsProxy.",
"format": "byte",
"type": "string"
},
"httpKeepAliveTimeoutSec": {
"description": "Specifies how long to keep a connection open, after completing a response,\nwhile there is no matching traffic (in seconds). If an HTTP keep-alive is\nnot specified, a default value (610 seconds) will be used.\n\nFor global external Application Load Balancers, the minimum allowed value\nis 5 seconds and the maximum allowed value is 1200 seconds.\n\nFor classic Application Load Balancers, this option is not supported.",
"format": "int32",
"type": "integer"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetHttpsProxy",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#targetHttpsProxy for target HTTPS proxies.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"proxyBind": {
"description": "This field only applies when the forwarding rule that references this\ntarget proxy has a loadBalancingScheme set toINTERNAL_SELF_MANAGED.\n\nWhen this field is set to true, Envoy proxies set up inbound\ntraffic interception and bind to the IP address and port specified in the\nforwarding rule. This is generally useful when using Traffic Director to\nconfigure Envoy as a gateway or middle proxy (in other words, not a\nsidecar proxy). The Envoy proxy listens for inbound requests and handles\nrequests when it receives them.\n\nThe default is false.",
"type": "boolean"
},
"quicOverride": {
"description": "Specifies the QUIC override policy for this TargetHttpsProxy resource. This\nsetting determines whether the load balancer attempts to negotiate QUIC\nwith clients.\nYou can specify NONE, ENABLE, orDISABLE.\n   \n   - When quic-override is set to NONE,\n   Google manages whether QUIC is used.\n   - When quic-override is set to ENABLE, the\n   load balancer uses QUIC when possible.\n   - When quic-override is set to DISABLE, the\n   load balancer doesn't use QUIC.\n   - If the quic-override flag is not specified,NONE is implied.",
"enum": [
"DISABLE",
"ENABLE",
"NONE"
],
"enumDescriptions": [
"The load balancer will not attempt to negotiate QUIC with clients.",
"The load balancer will attempt to negotiate QUIC with clients.",
"No overrides to the default QUIC policy. This option is implicit if\nno QUIC override has been specified in the request."
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional TargetHttpsProxy\nresides. This field is not applicable to global TargetHttpsProxies.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"serverTlsPolicy": {
"description": "Optional. A URL referring to a networksecurity.ServerTlsPolicy resource\nthat describes how the proxy should authenticate inbound traffic.\n\n serverTlsPolicy only applies to a globalTargetHttpsProxy attached toglobalForwardingRules with theloadBalancingScheme set to INTERNAL_SELF_MANAGED\nor EXTERNAL orEXTERNAL_MANAGED or INTERNAL_MANAGED.\nIt also applies to a regional TargetHttpsProxy attached to\nregional forwardingRules with theloadBalancingScheme set to EXTERNAL_MANAGED orINTERNAL_MANAGED. For details whichServerTlsPolicy resources are accepted withINTERNAL_SELF_MANAGED and which with EXTERNAL,INTERNAL_MANAGED, EXTERNAL_MANAGEDloadBalancingScheme consult ServerTlsPolicy\ndocumentation.\n\n  If left blank, communications are not encrypted.",
"type": "string"
},
"sslCertificates": {
"description": "URLs to SslCertificate resources that are used to authenticate\nconnections between users and the load balancer. At least one SSL\ncertificate must be specified. SslCertificates do not apply when the load\nbalancing scheme is set to INTERNAL_SELF_MANAGED.\n\nThe URLs should refer to a SSL Certificate resource or Certificate Manager\nCertificate resource. Mixing Classic Certificates and Certificate Manager\nCertificates is not allowed. Certificate Manager Certificates must include\nthe certificatemanager API namespace. Using Certificate Manager\nCertificates in this field is not supported by Global external Application\nLoad Balancer or Classic Application Load Balancer, use certificate_map\ninstead.\n\nCurrently, you may specify up to 15 Classic SSL Certificates or up to 100\nCertificate Manager Certificates.\n\nCertificate Manager Certificates accepted formats are:\n   \n   - //certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificates/{resourceName}.\n   - https://certificatemanager.googleapis.com/v1alpha1/projects/{project}/locations/{location}/certificates/{resourceName}.",
"items": {
"type": "string"
},
"type": "array"
},
"sslPolicy": {
"description": "URL of SslPolicy resource that will be associated with the TargetHttpsProxy\nresource. If not set, the TargetHttpsProxy resource has no\nSSL policy configured.",
"type": "string"
},
"tlsEarlyData": {
"description": "Specifies whether TLS 1.3 0-RTT Data (\"Early Data\") should be accepted\nfor this service. Early Data allows a TLS resumption handshake to include\nthe initial application payload (a HTTP request) alongside the handshake,\nreducing the effective round trips to \"zero\". This applies to TLS 1.3\nconnections over TCP (HTTP/2) as well as over UDP (QUIC/h3).\n\n\nThis can improve application performance, especially on networks where\ninterruptions may be common, such as on mobile.\n\n\nRequests with Early Data will have the \"Early-Data\" HTTP header set on\nthe request, with a value of \"1\", to allow the backend to determine whether\nEarly Data was included.\n\n\nNote: TLS Early Data may allow requests to be replayed, as the data is\nsent to the backend before the handshake has fully completed. Applications\nthat allow idempotent HTTP methods to make non-idempotent changes, such as\na GET request updating a database, should not accept Early Data on those\nrequests, and reject requests with the \"Early-Data: 1\" HTTP header by\nreturning a HTTP 425 (Too Early) status code, in order to remain RFC\ncompliant.\n\n\nThe default value is DISABLED.",
"enum": [
"DISABLED",
"PERMISSIVE",
"STRICT",
"UNRESTRICTED"
],
"enumDescriptions": [
"TLS 1.3 Early Data is not advertised, and any (invalid) attempts to send\nEarly Data will be rejected by closing the connection.",
"This enables TLS 1.3 0-RTT, and only allows Early Data to be included on\nrequests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE). This mode\ndoes not enforce any other limitations for requests with Early Data. The\napplication owner should validate that Early Data is acceptable for a\ngiven request path.",
"This enables TLS 1.3 0-RTT, and only allows Early Data to be included on\nrequests with safe HTTP methods (GET, HEAD, OPTIONS, TRACE) without query\nparameters. Requests that send Early Data with non-idempotent HTTP\nmethods or with query parameters will be rejected with a HTTP 425.",
"This enables TLS 1.3 Early Data for requests with any HTTP method\nincluding non-idempotent methods list POST. This mode does not enforce\nany other limitations. This may be valuable for gRPC use cases. However,\nwe do not recommend this method unless you have evaluated your security\nstance and mitigated the risk of replay attacks using other mechanisms."
],
"type": "string"
},
"urlMap": {
"description": "A fully-qualified or valid partial URL to the UrlMap resource that defines\nthe mapping from URL to the BackendService. For example, the following are\nall valid URLs for specifying a URL map:\n   \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. [Output Only] Type of resource. Alwayscompute#targetHttpsProxyAggregatedList for lists of Target\nHTTP Proxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": "Output only. Type of resource. Always compute#targetHttpsProxyList for\nlists of target HTTPS proxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nrules, which is ideal for forwarding protocol traffic that is managed by a\nsingle source. For example, ESP, AH, TCP, or UDP.\nFor more information, readTarget\ninstances.",
"id": "TargetInstance",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"instance": {
"description": "A URL to the virtual machine instance that handles traffic for this target\ninstance. When creating a target instance, you can provide the\nfully-qualified URL or a valid partial URL to the desired virtual machine.\nFor example, the following are all valid URLs:\n   \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. [Output Only] The type of the resource. Alwayscompute#targetInstance for target instances.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"natPolicy": {
"description": "Must have a value of NO_NAT.\nProtocol forwarding delivers packets while preserving the destination IP\naddress of the forwarding rule referencing the target instance.",
"enum": [
"NO_NAT"
],
"enumDescriptions": [
"No NAT performed."
],
"type": "string"
},
"network": {
"description": "The URL of the network this target instance uses to forward traffic.\nIf not specified, the traffic will be forwarded to the network that\nthe default network interface belongs to.",
"type": "string"
},
"securityPolicy": {
"description": "[Output Only] The resource URL for the security policy associated with this\ntarget instance.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for the resource.",
"type": "string"
},
"zone": {
"description": "Output only. [Output Only] URL of the zone where the target instance resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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 with external passthrough Network Load Balancers.\nA target pool references member instances, an associated legacy\nHttpHealthCheck resource, and, optionally, a backup target pool.\nFor more information, readUsing target pools.",
"id": "TargetPool",
"properties": {
"backupPool": {
"description": "The server-defined URL for the resource. This field is applicable only when\nthe containing target pool is serving a forwarding rule as the primary\npool, and its failoverRatio field is properly set to a value\nbetween [0, 1].backupPool and failoverRatio together define\nthe fallback behavior of the primary target pool: if the ratio of the\nhealthy instances in the primary pool is at or belowfailoverRatio, traffic arriving at the load-balanced\nIP will be directed to the backup pool.\n\nIn case where failoverRatio and backupPool\nare not set, or all the instances in the backup pool are unhealthy,\nthe traffic will be directed back to the primary pool in the \"force\"\nmode, where traffic will be spread to the healthy instances with the\nbest effort, or to all instances when no instance is healthy.",
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"failoverRatio": {
"description": "This field is applicable only when the containing target pool is serving a\nforwarding rule as the primary pool (i.e., not as a backup pool to some\nother target pool). The value of the field must be in [0, 1].\n\nIf set, backupPool must also be set. They together define\nthe fallback behavior of the primary target pool: if the ratio of the\nhealthy instances in the primary pool is at or below this number,\ntraffic arriving at the load-balanced IP will be directed to the\nbackup pool.\n\nIn case where failoverRatio is not set or all the\ninstances in the backup pool are unhealthy, the traffic will be\ndirected back to the primary pool in the \"force\" mode, where traffic\nwill be spread to the healthy instances with the\nbest 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\npool is considered healthy if and only if the health checks pass.\nOnly legacy HttpHealthChecks are supported. Only one health check may be\nspecified.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"instances": {
"description": "A list of resource URLs to the virtual machine instances serving this pool.\nThey must live in zones contained in the same region as this pool.",
"items": {
"type": "string"
},
"type": "array"
},
"kind": {
"default": "compute#targetPool",
"description": "Output only. [Output Only] Type of the resource. Always compute#targetPool\nfor target pools.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the target pool resides.",
"readOnly": true,
"type": "string"
},
"securityPolicy": {
"description": "[Output Only] The resource URL for the security policy associated with this\ntarget pool.",
"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\n    instance in the pool. \nCLIENT_IP: Connections from the same client IP will go\n    to the same instance in\n    the pool while that instance remains healthy. \nCLIENT_IP_PROTO: Connections from the same client IP\n    with the same IP protocol will go to the same instance in the\n    pool while that instance remains healthy.",
"enum": [
"CLIENT_IP",
"CLIENT_IP_NO_DESTINATION",
"CLIENT_IP_PORT_PROTO",
"CLIENT_IP_PROTO",
"GENERATED_COOKIE",
"HEADER_FIELD",
"HTTP_COOKIE",
"NONE",
"STRONG_COOKIE_AFFINITY"
],
"enumDescriptions": [
"2-tuple hash on packet's source and destination IP addresses. Connections\nfrom the same source IP address to the same destination IP address will be\nserved by the same backend VM while that VM remains healthy.",
"1-tuple hash only on packet's source IP address. Connections from the\nsame source IP address will be served by the same backend VM while that VM\nremains healthy. This option can only be used for Internal TCP/UDP\nLoad Balancing.",
"5-tuple hash on packet's source and destination IP addresses, IP protocol,\nand source and destination ports. Connections for the same IP protocol\nfrom the same source IP address and port to the same destination IP address\nand port will be served by the same backend VM while that VM remains\nhealthy. This option cannot be used for HTTP(S) load balancing.",
"3-tuple hash on packet's source and destination IP addresses, and IP\nprotocol. Connections for the same IP protocol from the same source IP\naddress to the same destination IP address will be served by the same\nbackend VM while that VM remains healthy. This option cannot be used for\nHTTP(S) load balancing.",
"Hash based on a cookie generated by the L7 loadbalancer.\nOnly valid for HTTP(S) load balancing.",
"The hash is based on a user specified header field.",
"The hash is based on a user provided cookie.",
"No session affinity. Connections from the same client IP may go\nto any instance in the pool.",
"Strong cookie-based affinity. Connections bearing the same cookie will be\nserved by the same backend VM while that VM remains healthy, as long as the\ncookie has not expired."
],
"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. [Output Only] Type of resource. Alwayscompute#targetPoolAggregatedList for aggregated lists of\ntarget pools.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Alwayscompute#targetPoolInstanceHealth when checking the health of\nan instance.",
"readOnly": true,
"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. [Output Only] Type of resource. Always compute#targetPoolList\nfor lists of target pools.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nbe a full or partial URL. For example, the following are valid URLs: \n   \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.\nFor example, the following are valid URLs:\n   \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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"TargetSslProxiesSetCertificateMapRequest": {
"id": "TargetSslProxiesSetCertificateMapRequest",
"properties": {
"certificateMap": {
"description": "URL of the Certificate Map to associate with this TargetSslProxy.\n\n Accepted format is//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}.",
"type": "string"
}
},
"type": "object"
},
"TargetSslProxiesSetProxyHeaderRequest": {
"id": "TargetSslProxiesSetProxyHeaderRequest",
"properties": {
"proxyHeader": {
"description": "The new type of proxy header to append before sending data to the\nbackend.  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\nTargetSslProxy. At least one SSL certificate must be specified.\nCurrently, you may specify up to 15 SSL certificates.",
"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 Proxy Network Load Balancer.\nThe forwarding rule references the target SSL proxy, and the target proxy\nthen references a backend service. For more information, readProxy Network\nLoad Balancer overview.",
"id": "TargetSslProxy",
"properties": {
"certificateMap": {
"description": "URL of a certificate map that identifies a certificate map associated with\nthe given target proxy.\nThis field can only be set for global target proxies.\nIf set, sslCertificates will be ignored.\n\n Accepted format is//certificatemanager.googleapis.com/projects/{project}/locations/{location}/certificateMaps/{resourceName}.",
"type": "string"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetSslProxy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#targetSslProxy for target SSL proxies.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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\nbackend, either NONE or PROXY_V1. The default\nis 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\nauthenticate connections to Backends. At least one SSL certificate\nmust be specified. Currently, you may specify up to 15 SSL certificates.\nsslCertificates do not apply when the load balancing scheme is set to\nINTERNAL_SELF_MANAGED.",
"items": {
"type": "string"
},
"type": "array"
},
"sslPolicy": {
"description": "URL of SslPolicy resource that will be associated with the TargetSslProxy\nresource. If not set, the TargetSslProxy resource will not have any\nSSL 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"TargetTcpProxiesScopedList": {
"id": "TargetTcpProxiesScopedList",
"properties": {
"targetTcpProxies": {
"description": "A list of TargetTcpProxies contained in this scope.",
"items": {
"$ref": "TargetTcpProxy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nbackend.  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 Proxy Network Load Balancer.\nThe forwarding rule references the target TCP proxy, and the target proxy\nthen references a backend service. For more information, readProxy Network\nLoad Balancer overview.",
"id": "TargetTcpProxy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetTcpProxy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#targetTcpProxy for target TCP proxies.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"proxyBind": {
"description": "This field only applies when the forwarding rule that references this\ntarget proxy has a loadBalancingScheme set toINTERNAL_SELF_MANAGED.\n\nWhen this field is set to true, Envoy proxies set up inbound\ntraffic interception and bind to the IP address and port specified in the\nforwarding rule. This is generally useful when using Traffic Director to\nconfigure Envoy as a gateway or middle proxy (in other words, not a\nsidecar proxy). The Envoy proxy listens for inbound requests and handles\nrequests when it receives them.\n\nThe default is false.",
"type": "boolean"
},
"proxyHeader": {
"description": "Specifies the type of proxy header to append before sending data to the\nbackend, either NONE or PROXY_V1. The default\nis NONE.",
"enum": [
"NONE",
"PROXY_V1"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"region": {
"description": "Output only. [Output Only] URL of the region where the regional TCP proxy resides.\nThis field is not applicable to global TCP proxy.",
"readOnly": true,
"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"
},
"TargetTcpProxyAggregatedList": {
"id": "TargetTcpProxyAggregatedList",
"properties": {
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "TargetTcpProxiesScopedList",
"description": "Name of the scope containing this set of TargetTcpProxies."
},
"description": "A list of TargetTcpProxiesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#targetTcpProxyAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#targetTcpProxyAggregatedList for lists of Target\nTCP Proxies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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.\nFor more information, read thethe\nCloud VPN Overview.",
"id": "TargetVpnGateway",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"forwardingRules": {
"description": "[Output Only] A list of URLs to the ForwardingRule resources.\nForwardingRules are created usingcompute.forwardingRules.insert and associated with a VPN\ngateway.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#targetVpnGateway",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this TargetVpnGateway, which\nis essentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a TargetVpnGateway.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"name": {
"annotations": {
"required": [
"compute.targetVpnGateways.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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\nclient when the VPN gateway is created.",
"type": "string"
},
"params": {
"$ref": "TargetVpnGatewayParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "[Output Only] URL of the region where the target VPN gateway resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot 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,\nwhich 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\ncreated using the compute.vpntunnels.insert method and\nassociated 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. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Alwayscompute#targetVpnGateway for target VPN gateways.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"TargetVpnGatewayParams": {
"id": "TargetVpnGatewayParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": {
"actualOutputUrl": {
"description": "The actual output URL evaluated by a load balancer containing the scheme,\nhost, path and query parameters.",
"type": "string"
},
"actualRedirectResponseCode": {
"description": "Actual HTTP status code for rule with `urlRedirect`\ncalculated by load balancer",
"format": "int32",
"type": "integer"
},
"actualService": {
"description": "BackendService or BackendBucket returned by load\nbalancer.",
"type": "string"
},
"expectedOutputUrl": {
"description": "The expected output URL evaluated by a load balancer containing the scheme,\nhost, path and query parameters.",
"type": "string"
},
"expectedRedirectResponseCode": {
"description": "Expected HTTP status code for rule with `urlRedirect`\ncalculated by load balancer",
"format": "int32",
"type": "integer"
},
"expectedService": {
"description": "Expected BackendService or BackendBucket resource\nthe given URL should be mapped to.",
"type": "string"
},
"headers": {
"description": "HTTP headers of the request.",
"items": {
"$ref": "UrlMapTestHeader"
},
"type": "array"
},
"host": {
"description": "Host portion of the URL.",
"type": "string"
},
"path": {
"description": "Path portion including query parameters in the URL.",
"type": "string"
}
},
"type": "object"
},
"TestPermissionsRequest": {
"id": "TestPermissionsRequest",
"properties": {
"permissions": {
"description": "The set of permissions to check for the 'resource'. Permissions with\nwildcards (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\nallowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"Uint128": {
"id": "Uint128",
"properties": {
"high": {
"format": "uint64",
"type": "string"
},
"low": {
"format": "uint64",
"type": "string"
}
},
"type": "object"
},
"UpcomingMaintenance": {
"description": "Upcoming Maintenance notification information.",
"id": "UpcomingMaintenance",
"properties": {
"canReschedule": {
"description": "Indicates if the maintenance can be customer triggered.",
"type": "boolean"
},
"latestWindowStartTime": {
"description": "The latest time for the planned maintenance window to start.\nThis timestamp value is in RFC3339 text format.",
"type": "string"
},
"maintenanceOnShutdown": {
"description": "Indicates whether the UpcomingMaintenance will be triggered on VM shutdown.",
"type": "boolean"
},
"maintenanceReasons": {
"description": "The reasons for the maintenance. Only valid for vms.",
"items": {
"enum": [
"FAILURE_DISK",
"FAILURE_GPU",
"FAILURE_GPU_MULTIPLE_FAULTY_HOSTS_CUSTOMER_REPORTED",
"FAILURE_GPU_NVLINK_SWITCH_CUSTOMER_REPORTED",
"FAILURE_GPU_TEMPERATURE",
"FAILURE_GPU_XID",
"FAILURE_INFRA",
"FAILURE_INTERFACE",
"FAILURE_MEMORY",
"FAILURE_NETWORK",
"FAILURE_NVLINK",
"FAILURE_REDUNDANT_HARDWARE_FAULT",
"FAILURE_TPU",
"INFRASTRUCTURE_RELOCATION",
"MAINTENANCE_REASON_UNKNOWN",
"PLANNED_NETWORK_UPDATE",
"PLANNED_UPDATE"
],
"enumDescriptions": [
"Maintenance due to disk errors.",
"Maintenance due to GPU errors.",
"Maintenance due to customer reported multiple faulty hosts via R&R\nSubblock API.",
"Maintenance due to customer reported NVLink switch failure via R&R\nSubblock API.",
"Maintenance due to high GPU temperature.",
"Maintenance due to GPU xid failure.",
"Maintenance due to infrastructure errors.",
"Maintenance due to interface errors.",
"Maintenance due to memory errors.",
"Maintenance due to network errors.",
"Maintenance due to NVLink failure.",
"Maintenance due to redundant hardware fault.",
"Maintenance due to TPU errors.",
"Maintenance due to infrastructure relocation.",
"Unknown maintenance reason. Do not use this value.",
"Maintenance due to planned network update.",
"Maintenance due to planned update to the instance."
],
"type": "string"
},
"type": "array"
},
"maintenanceStatus": {
"enum": [
"ONGOING",
"PENDING",
"UNKNOWN"
],
"enumDescriptions": [
"There is ongoing maintenance on this VM.",
"There is pending maintenance.",
"Unknown maintenance status. Do not use this value."
],
"type": "string"
},
"type": {
"description": "Defines the type of maintenance.",
"enum": [
"MULTIPLE",
"SCHEDULED",
"UNKNOWN_TYPE",
"UNSCHEDULED"
],
"enumDescriptions": [
"Multiple maintenance types in one window.\nThis is only intended to be used for groups.",
"Scheduled maintenance (e.g. maintenance after uptime guarantee is\ncomplete).",
"No type specified. Do not use this value.",
"Unscheduled maintenance (e.g. emergency maintenance during\nuptime guarantee)."
],
"type": "string"
},
"windowEndTime": {
"description": "The time by which the maintenance disruption will be completed.\nThis timestamp value is in RFC3339 text format.",
"type": "string"
},
"windowStartTime": {
"description": "The current start time of the maintenance window.\nThis timestamp value is in RFC3339 text format.",
"type": "string"
}
},
"type": "object"
},
"UrlMap": {
"description": "Represents a URL Map resource.\n\nCompute Engine has two URL Map resources:\n\n* [Global](/compute/docs/reference/rest/v1/urlMaps)\n* [Regional](/compute/docs/reference/rest/v1/regionUrlMaps)\n\nA URL map resource is a component of certain types of cloud load balancers\nand Traffic Director:\n\n* urlMaps are used by global external Application Load\nBalancers, classic Application Load Balancers, and cross-region internal\nApplication Load Balancers.\n* regionUrlMaps are used by internal Application Load Balancers,\nregional external Application Load Balancers and regional internal\nApplication Load Balancers.\n\nFor a list of supported URL map features by the load balancer type, see the\nLoad balancing features: Routing and traffic management table.\n\nFor a list of supported URL map features for Traffic Director, see the\nTraffic Director features: Routing and traffic management table.\n\nThis resource defines mappings from hostnames and URL paths to either a\nbackend service or a backend bucket.\n\nTo use the global urlMaps resource, the backend service must\nhave a loadBalancingScheme of either EXTERNAL,EXTERNAL_MANAGED, or INTERNAL_SELF_MANAGED. To use\nthe regionUrlMaps resource, the backend service must have aloadBalancingScheme of INTERNAL_MANAGED. For more\ninformation, read URL\nMap Concepts.",
"id": "UrlMap",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"defaultCustomErrorResponsePolicy": {
"$ref": "CustomErrorResponsePolicy",
"description": "defaultCustomErrorResponsePolicy specifies how the Load\nBalancer returns error responses when BackendServiceorBackendBucket responds with an error. \n\nThis policy takes\neffect at the load balancer level and applies only when no policy has been\ndefined for the error code at lower levels like PathMatcher, RouteRule and\nPathRule within this UrlMap. \n\nFor example, consider a UrlMap with the\nfollowing configuration:\n   \n   \n     - defaultCustomErrorResponsePolicy containing policies for\n     responding to 5xx and 4xx errors\n     - A PathMatcher configured for *.example.com has\n     defaultCustomErrorResponsePolicy for 4xx.\n\nIf a request for http://www.example.com/ encounters a404, the policy inpathMatcher.defaultCustomErrorResponsePolicy will be enforced.\nWhen the request for http://www.example.com/ encounters a502, the policy inUrlMap.defaultCustomErrorResponsePolicy will be enforced. When\na request that does not match any host in *.example.com such\nas http://www.myotherexample.com/, encounters a404, UrlMap.defaultCustomErrorResponsePolicy\ntakes effect. \n\nWhen used in conjunction withdefaultRouteAction.retryPolicy, retries take precedence. Only\nonce all retries are exhausted, thedefaultCustomErrorResponsePolicy is applied. While attempting\na retry, if load balancer is successful in reaching the\nservice, the defaultCustomErrorResponsePolicy is ignored and\nthe response from the service is returned to the client.\n\ndefaultCustomErrorResponsePolicy is supported only for\nglobal external Application Load Balancers."
},
"defaultRouteAction": {
"$ref": "HttpRouteAction",
"description": "defaultRouteAction takes effect when none of the \nhostRules match. The load balancer performs advanced routing\nactions, such as URL rewrites and header transformations, before forwarding\nthe request to the selected backend.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\n URL maps for classic Application Load Balancers only support\nthe urlRewrite action within defaultRouteAction.\n\n\ndefaultRouteAction has no effect when the URL map is bound\nto a target gRPC proxy that has the validateForProxyless field\nset to true."
},
"defaultService": {
"description": "The full or partial URL of the defaultService resource to\nwhich traffic is directed if none of the hostRules match.\nIf defaultRouteAction is also specified, advanced\nrouting actions, such as URL rewrites, take effect before sending the\nrequest to the backend.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\ndefaultService has no effect when the URL map is bound\nto a target gRPC proxy that has the validateForProxyless field\nset to true.",
"type": "string"
},
"defaultUrlRedirect": {
"$ref": "HttpRedirectAction",
"description": "When none of the specified hostRules match, the request\nis redirected to a URL specified by defaultUrlRedirect.\n\n\nOnly one of defaultUrlRedirect, defaultService\nor defaultRouteAction.weightedBackendService can be set.\n\n\nNot supported when the URL map is bound to a target gRPC proxy."
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"fingerprint": {
"description": "Fingerprint of this resource. A hash of the contents stored in this object.\nThis field is used in optimistic locking. This field is ignored when\ninserting a UrlMap. An up-to-date fingerprint must be provided\nin order to update the UrlMap, otherwise the request will\nfail with error 412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a UrlMap.",
"format": "byte",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take effect\nfor the selected backendService.\n\nThe headerAction specified here take effect afterheaderAction specified under pathMatcher.\n\nheaderAction is not supported for load balancers\nthat have\ntheir loadBalancingScheme set to EXTERNAL.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true."
},
"hostRules": {
"description": "The list of host rules to use against the URL.",
"items": {
"$ref": "HostRule"
},
"type": "array"
},
"id": {
"description": "[Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#urlMap",
"description": "Output only. [Output Only] Type of the resource. Always compute#urlMaps for\nurl maps.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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. [Output Only] URL of the region where the regional URL map resides.\nThis field is not applicable to global URL maps.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"readOnly": true,
"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 theUrlMap succeeds only if all test cases pass. You can specify a\nmaximum of 100 tests per UrlMap.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true.",
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"expectedOutputUrl": {
"description": "The expected output URL evaluated by the load balancer\ncontaining the scheme, host, path and query parameters.\n\nFor rules that forward requests to backends, the test passes only whenexpectedOutputUrl matches the request forwarded by\nthe load balancer to backends. For rules with urlRewrite,\nthe test verifies that the forwarded request matcheshostRewrite and pathPrefixRewrite in theurlRewrite action. When service is specified,expectedOutputUrl`s scheme is ignored.\n\nFor rules with urlRedirect, the test passes only ifexpectedOutputUrl matches the URL in the load balancer's\nredirect response. If urlRedirect specifieshttps_redirect, the test passes only if the scheme inexpectedOutputUrl is also set to HTTPS.\nIf urlRedirect specifies strip_query, the test\npasses only if expectedOutputUrl does not contain any query\nparameters. \n\nexpectedOutputUrl is optional whenservice is specified.",
"type": "string"
},
"expectedRedirectResponseCode": {
"description": "For rules with urlRedirect, the test passes only ifexpectedRedirectResponseCode matches the HTTP status code in\nload balancer's redirect response.\n\nexpectedRedirectResponseCode cannot be set whenservice is set.",
"format": "int32",
"type": "integer"
},
"headers": {
"description": "HTTP headers for this request. If headers contains\na host header, then host must also match the header value.",
"items": {
"$ref": "UrlMapTestHeader"
},
"type": "array"
},
"host": {
"description": "Host portion of the URL. If headers contains a host header,\nthen host must also match the header value.",
"type": "string"
},
"path": {
"description": "Path portion of the URL.",
"type": "string"
},
"service": {
"description": "Expected BackendService or BackendBucket resource\nthe given URL should be mapped to. \n\nThe service field cannot\nbe set if expectedRedirectResponseCode is set.",
"type": "string"
}
},
"type": "object"
},
"UrlMapTestHeader": {
"description": "HTTP headers used in UrlMapTests.",
"id": "UrlMapTestHeader",
"properties": {
"name": {
"description": "Header name.",
"type": "string"
},
"value": {
"description": "Header value.",
"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.\nIf 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.\nIf 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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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": {
"loadBalancingSchemes": {
"description": "Specifies the load balancer type(s) this validation request is for. UseEXTERNAL_MANAGED for global external Application Load\nBalancers and regional external Application Load Balancers.\nUse EXTERNAL for classic Application Load Balancers.\n\nUse INTERNAL_MANAGED for internal Application Load Balancers. For more\ninformation, refer to Choosing\na load balancer.\n\nIf unspecified, the load balancing scheme will be inferred from the backend\nservice resources this URL map references. If that can not be inferred (for\nexample, this URL map only references backend buckets, or this Url map is\nfor rewrites and redirects only and doesn't reference any backends),EXTERNAL will be used as the default type.\n\nIf specified, the scheme(s) must not conflict with the load balancing\nscheme of the backend service resources this Url map references.",
"items": {
"enum": [
"EXTERNAL",
"EXTERNAL_MANAGED",
"LOAD_BALANCING_SCHEME_UNSPECIFIED"
],
"enumDescriptions": [
"Signifies that this will be used for classic Application Load Balancers.",
"Signifies that this will be used for Envoy-based global external\nApplication Load Balancers.",
"If unspecified, the validation will try to infer the scheme from the\nbackend service resources this Url map references. If the inference is not\npossible, EXTERNAL will be used as the default type."
],
"type": "string"
},
"type": "array"
},
"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\nbackend service.",
"id": "UrlRewrite",
"properties": {
"hostRewrite": {
"description": "Before forwarding the request to the selected service, the request's\nhost header is replaced with contents of hostRewrite.\n\nThe value must be from 1 to 255 characters.",
"type": "string"
},
"pathPrefixRewrite": {
"description": "Before forwarding the request to the selected backend service, the\nmatching portion of the request's path is replaced bypathPrefixRewrite.\n\nThe value must be from 1 to 1024 characters.",
"type": "string"
},
"pathTemplateRewrite": {
"description": "If specified, the pattern rewrites the URL path (based on the :path\nheader) using the HTTP template syntax. \n\nA corresponding\npath_template_match must be specified. Any template variables must exist in\nthe path_template_match field. \n   \n   \n      - -At least one variable must be specified in the path_template_match\n      field \n   - You can omit variables from the rewritten URL\n      - The * and ** operators cannot be matched\n      unless they have a corresponding variable name - e.g.\n      {format=*} or {var=**}.\n\nFor example, a path_template_match of /static/{format=**}\ncould be rewritten as /static/content/{format} to prefix/content to the URL. Variables can also be re-ordered in a\nrewrite, so that /{country}/{format}/{suffix=**} can be\nrewritten as /content/{format}/{country}/{suffix}. \n\nAt least\none non-empty routeRules[].matchRules[].path_template_match is\nrequired. \n\nOnly one of path_prefix_rewrite orpath_template_rewrite may be specified.",
"type": "string"
}
},
"type": "object"
},
"UsableSubnetwork": {
"description": "Subnetwork which the current user has compute.subnetworks.use permission on.",
"id": "UsableSubnetwork",
"properties": {
"externalIpv6Prefix": {
"description": "Output only. [Output Only] The external IPv6 address range that is assigned to this\nsubnetwork.",
"readOnly": true,
"type": "string"
},
"internalIpv6Prefix": {
"description": "Output only. [Output Only] The internal IPv6 address range that is assigned to this\nsubnetwork.",
"readOnly": true,
"type": "string"
},
"ipCidrRange": {
"description": "The range of internal addresses that are owned by this subnetwork.",
"type": "string"
},
"ipv6AccessType": {
"description": "The access type of IPv6 address this subnet holds. It's immutable and can\nonly be specified during creation or the first time the subnet is updated\ninto IPV4_IPV6 dual stack.",
"enum": [
"EXTERNAL",
"INTERNAL"
],
"enumDescriptions": [
"VMs on this subnet will be assigned IPv6 addresses that are accessible\nvia the Internet, as well as the VPC network.",
"VMs on this subnet will be assigned IPv6 addresses that are only\naccessible over the VPC network."
],
"type": "string"
},
"network": {
"description": "Network URL.",
"type": "string"
},
"purpose": {
"enum": [
"GLOBAL_MANAGED_PROXY",
"INTERNAL_HTTPS_LOAD_BALANCER",
"PEER_MIGRATION",
"PRIVATE",
"PRIVATE_NAT",
"PRIVATE_RFC_1918",
"PRIVATE_SERVICE_CONNECT",
"REGIONAL_MANAGED_PROXY"
],
"enumDescriptions": [
"Subnet reserved for Global Envoy-based Load Balancing.",
"Subnet reserved for Internal HTTP(S) Load Balancing. This is a legacy\npurpose, please use REGIONAL_MANAGED_PROXY instead.",
"Subnetwork will be used for Migration from one peered VPC to another.\n(a transient state of subnetwork\nwhile migrating resources from one project to another).",
"Regular user created or automatically created subnet.",
"Subnetwork used as source range for Private NAT Gateways.",
"Regular user created or automatically created subnet.",
"Subnetworks created for Private Service Connect in the producer network.",
"Subnetwork used for Regional Envoy-based Load Balancing."
],
"type": "string"
},
"role": {
"description": "The role of subnetwork. Currently, this field is only used when\npurpose is set to GLOBAL_MANAGED_PROXY orREGIONAL_MANAGED_PROXY. The value can be set toACTIVE or BACKUP. An ACTIVE\nsubnetwork is one that is currently being used for Envoy-based load\nbalancers in a region. A BACKUP subnetwork is one that is\nready to be promoted to ACTIVE or is currently draining.\nThis field can be updated with a patch request.",
"enum": [
"ACTIVE",
"BACKUP"
],
"enumDescriptions": [
"The ACTIVE subnet that is currently used.",
"The BACKUP subnet that could be promoted to ACTIVE."
],
"type": "string"
},
"secondaryIpRanges": {
"description": "Secondary IP ranges.",
"items": {
"$ref": "UsableSubnetworkSecondaryRange"
},
"type": "array"
},
"stackType": {
"description": "The stack type for the subnet. If set to IPV4_ONLY, new VMs\nin the subnet are assigned IPv4 addresses only. If set toIPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and\nIPv6 addresses. If not specified, IPV4_ONLY is used.\n\nThis field can be both set at resource creation time and updated usingpatch.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY",
"IPV6_ONLY"
],
"enumDescriptions": [
"New VMs in this subnet can have both IPv4 and IPv6 addresses.",
"New VMs in this subnet will only be assigned IPv4 addresses.",
"New VMs in this subnet will only be assigned IPv6 addresses."
],
"type": "string"
},
"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.\nCan be Ipv4 or Ipv6 range.",
"type": "string"
},
"rangeName": {
"description": "The name associated with this subnetwork secondary range, used when adding\nan alias IP range to a VM instance.\nThe name must be 1-63 characters long, and comply withRFC1035.\nThe 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\ndefined 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. [Output Only] Type of resource. Alwayscompute#usableSubnetworksAggregatedList for aggregated lists\nof usable subnetworks.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.\nIn special cases listUsable may return 0 subnetworks andnextPageToken which still should be used to get the\nnext page of results.",
"type": "string"
},
"scopedWarnings": {
"description": "Output only. [Output Only] Informational warning messages for failures encountered from\nscopes.",
"items": {
"$ref": "SubnetworksScopedWarning"
},
"readOnly": true,
"type": "array"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nreport. 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\nobject is stored. The Google Service Account is granted write access to\nthis bucket. This can either be the bucket name by itself, such asexample-bucket, or the bucket name with gs://\nor https://storage.googleapis.com/ in front of it, such\nas gs://example-bucket.",
"type": "string"
},
"reportNamePrefix": {
"description": "An optional prefix for the name of the usage report object stored inbucketName. If not supplied, defaults tousage_gce. The report is stored as a CSV file namedreport_name_prefix_gce_YYYYMMDD.csv whereYYYYMMDD is the day of the usage according to Pacific Time.\nIf you supply a prefix, it should conform to Cloud Storageobject naming\nconventions.",
"type": "string"
}
},
"type": "object"
},
"VmEndpointNatMappings": {
"description": "Contain information of Nat mapping for a VM endpoint (i.e., NIC).",
"id": "VmEndpointNatMappings",
"properties": {
"instanceName": {
"description": "Output only. Name of the VM instance which the endpoint belongs to",
"readOnly": true,
"type": "string"
},
"interfaceNatMappings": {
"items": {
"$ref": "VmEndpointNatMappingsInterfaceNatMappings"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"VmEndpointNatMappingsInterfaceNatMappings": {
"description": "Contain information of Nat mapping for an interface of this endpoint.",
"id": "VmEndpointNatMappingsInterfaceNatMappings",
"properties": {
"drainNatIpPortRanges": {
"description": "Output only. List of all drain IP:port-range mappings assigned to this interface.\nThese ranges are inclusive, that is, both the first and the last\nports can be used for NAT. Example: [\"2.2.2.2:12345-12355\",\n\"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"natIpPortRanges": {
"description": "Output only. A list of all IP:port-range mappings assigned to this interface.\nThese ranges are inclusive, that is, both the first and the last\nports can be used for NAT. Example: [\"2.2.2.2:12345-12355\",\n\"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"numTotalDrainNatPorts": {
"description": "Output only. Total number of drain ports across all NAT IPs allocated to this\ninterface. It equals to the aggregated port number in the field\ndrain_nat_ip_port_ranges.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"numTotalNatPorts": {
"description": "Output only. Total number of ports across all NAT IPs allocated to this interface.\nIt equals to the aggregated port number in the field nat_ip_port_ranges.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"ruleMappings": {
"description": "Output only. Information about mappings provided by rules in this NAT.",
"items": {
"$ref": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings"
},
"readOnly": true,
"type": "array"
},
"sourceAliasIpRange": {
"description": "Output only. Alias IP range for this interface endpoint.\nIt will be a private (RFC 1918) IP range.\nExamples: \"10.33.4.55/32\", or \"192.168.5.0/24\".",
"readOnly": true,
"type": "string"
},
"sourceVirtualIp": {
"description": "Output only. Primary IP of the VM for this NIC.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings": {
"description": "Contains information of NAT Mappings provided by a NAT Rule.",
"id": "VmEndpointNatMappingsInterfaceNatMappingsNatRuleMappings",
"properties": {
"drainNatIpPortRanges": {
"description": "Output only. List of all drain IP:port-range mappings assigned to this interface\nby this rule.\nThese ranges are inclusive, that is, both the first and the last\nports can be used for NAT. Example: [\"2.2.2.2:12345-12355\",\n\"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"natIpPortRanges": {
"description": "Output only. A list of all IP:port-range mappings assigned to this interface by this\nrule.\nThese ranges are inclusive, that is, both the first and the last\nports can be used for NAT. Example: [\"2.2.2.2:12345-12355\",\n\"1.1.1.1:2234-2234\"].",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"numTotalDrainNatPorts": {
"description": "Output only. Total number of drain ports across all NAT IPs allocated to this\ninterface by this rule.\nIt equals the aggregated port number in the field\ndrain_nat_ip_port_ranges.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"numTotalNatPorts": {
"description": "Output only. Total number of ports across all NAT IPs allocated to this interface\nby this rule.\nIt equals the aggregated port number in the field nat_ip_port_ranges.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"ruleNumber": {
"description": "Output only. Rule number of the NAT Rule.",
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"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\ndefined by the server.",
"type": "string"
},
"kind": {
"default": "compute#vmEndpointNatMappingsList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#vmEndpointNatMappingsList for lists of Nat mappings of\nVM endpoints.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue 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. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VmExtensionPoliciesScopedList": {
"id": "VmExtensionPoliciesScopedList",
"properties": {
"vmExtensionPolicies": {
"description": "List of VmExtensionPolicy resources contained in this scope.",
"items": {
"$ref": "VmExtensionPolicy"
},
"type": "array"
},
"warning": {
"description": "Informational warning which replaces the list of\nbackend services when the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VmExtensionPolicy": {
"description": "Represents a VM extension policy.",
"id": "VmExtensionPolicy",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource.",
"type": "string"
},
"extensionPolicies": {
"additionalProperties": {
"$ref": "VmExtensionPolicyExtensionPolicy"
},
"description": "Required. A map of extension names (for example, \"ops-agent\") to their corresponding\npolicy configurations.",
"type": "object"
},
"globalResourceLink": {
"description": "Optional. Output only. [Output Only] Link to the global policy that manages this zone policy, if\napplicable.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"instanceSelectors": {
"description": "Optional. Selectors to target VMs for this policy. VMs are selected if they match\n*any* of the provided selectors (logical OR). If this list is empty, the\npolicy applies to all VMs.",
"items": {
"$ref": "VmExtensionPolicyInstanceSelector"
},
"type": "array"
},
"kind": {
"default": "compute#vmExtensionPolicy",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#vmExtensionPolicy.",
"readOnly": true,
"type": "string"
},
"managedByGlobal": {
"description": "Optional. Output only. [Output Only] Indicates if this policy is managed by a global policy.",
"readOnly": true,
"type": "boolean"
},
"name": {
"annotations": {
"required": [
"compute.zoneVmExtensionPolicies.insert"
]
},
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?`\nwhich means the first character must be a lowercase letter, and all\nfollowing characters must be a dash, lowercase letter, or digit, except\nthe last character, which cannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"priority": {
"description": "Optional. Priority of this policy. Used to resolve conflicts when multiple policies\napply to the same extension.\nThe policy priority is an integer from 0 to 65535, inclusive. Lower\nintegers indicate higher priorities. If you do not specify a priority when\ncreating a rule, it is assigned a priority of 1000. If priorities are\nequal, the policy with the most recent creation timestamp takes precedence.",
"format": "int32",
"type": "integer"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined fully-qualified URL for this resource.",
"readOnly": true,
"type": "string"
},
"selfLinkWithId": {
"description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Optional. Output only. [Output Only] Current state of the policy: ACTIVE or DELETING.",
"enum": [
"ACTIVE",
"DELETING",
"STATE_UNSPECIFIED"
],
"enumDescriptions": [
"The policy is active and applied to matching VMs.\nNewly created VMs that match the policy will also receive the\nextension policy.",
"The policy is in the process of being deleted. After the extension is\nremoved from all matching VMs, the policy will be deleted.",
"Default value. Do not use."
],
"readOnly": true,
"type": "string"
},
"updateTimestamp": {
"description": "Output only. [Output Only] Update timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"VmExtensionPolicyAggregatedListResponse": {
"description": "Response for the aggregated list of VM extension policies.",
"id": "VmExtensionPolicyAggregatedListResponse",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"additionalProperties": {
"$ref": "VmExtensionPoliciesScopedList",
"description": "Name of the scope containing this set of VmExtensionPolicies."
},
"description": "A list of VmExtensionPoliciesScopedList resources.",
"type": "object"
},
"kind": {
"default": "compute#VmExtensionPolicyAggregatedList",
"description": "Output only. [Output Only] Type of resource. Alwayscompute#VmExtensionPolicyAggregatedList for lists of\nVmExtensionPolicies.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VmExtensionPolicyExtensionPolicy": {
"description": "Configuration for a specific VM extension.",
"id": "VmExtensionPolicyExtensionPolicy",
"properties": {
"pinnedVersion": {
"description": "Optional. The specific version of the extension to install. If not set, the latest\nversion is used.",
"type": "string"
},
"stringConfig": {
"description": "Optional. String-based configuration data for the extension.",
"type": "string"
}
},
"type": "object"
},
"VmExtensionPolicyInstanceSelector": {
"description": "Defines how to select VMs to apply a zone VM extension policy.",
"id": "VmExtensionPolicyInstanceSelector",
"properties": {
"labelSelector": {
"$ref": "VmExtensionPolicyLabelSelector",
"description": "Optional. LabelSelector selects VMs based on their labels."
}
},
"type": "object"
},
"VmExtensionPolicyLabelSelector": {
"description": "A LabelSelector is applied to a VM only if it matches all the specified\nlabels.",
"id": "VmExtensionPolicyLabelSelector",
"properties": {
"inclusionLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A map of key-value pairs representing VM labels.\nVMs must have all of the labels specified in this map to be selected\n(logical AND).\n\ne.g. If the `inclusion_labels` are {(\"key1\", \"value1\"), (\"key2\",\n\"value2\")}, the VM labels must contain both (\"key1\", \"value1\") and\n(\"key2\", \"value2\") to be selected. If the VM labels are (\"key1\",\n\"value1\") and (\"something\", \"else\"), it will not be selected.\n\nIf the map is empty, it's considered a match.",
"type": "object"
}
},
"type": "object"
},
"VmExtensionPolicyList": {
"id": "VmExtensionPolicyList",
"properties": {
"etag": {
"description": "Output only. [Output Only] Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. This field will\nbe ignored when inserting a VmExtensionPolicy. An up-to-date\nfingerprint must be provided in order to update the VmExtensionPolicy.\n\nTo see the latest value of the fingerprint, make a get() request to\nretrieve a VmExtensionPolicy.",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Output only. [Output Only] Unique identifier for the resource; defined by the server.",
"readOnly": true,
"type": "string"
},
"items": {
"description": "Output only. [Output Only] A list of VM extension policy resources.",
"items": {
"$ref": "VmExtensionPolicy"
},
"readOnly": true,
"type": "array"
},
"kind": {
"default": "compute#vmExtensionPolicyList",
"description": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "Output only. [Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "Output only. [Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
}
},
"readOnly": true,
"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\nconnect your on-premises network to your Google Cloud Virtual Private Cloud\nnetwork through an IPsec VPN connection in a single region.\nFor more information about Cloud HA VPN solutions, see\nCloud VPN topologies .",
"id": "VpnGateway",
"properties": {
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
"type": "string"
},
"gatewayIpVersion": {
"description": "The IP family of the gateway IPs for the HA-VPN gateway interfaces. If not\nspecified, IPV4 will be used.",
"enum": [
"IPV4",
"IPV6"
],
"enumDescriptions": [
"Every HA-VPN gateway interface is configured with an IPv4 address.",
"Every HA-VPN gateway interface is configured with an IPv6 address."
],
"type": "string"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#vpnGateway",
"description": "Output only. [Output Only] Type of resource. Always compute#vpnGateway for\nVPN gateways.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this VpnGateway, which\nis essentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a VpnGateway.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel 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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot 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\nclient when the VPN gateway is created.",
"type": "string"
},
"params": {
"$ref": "VpnGatewayParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"region": {
"description": "Output only. [Output Only] URL of the region where the VPN gateway resides.",
"readOnly": true,
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"stackType": {
"description": "The stack type for this VPN gateway to identify the IP protocols that are\nenabled. Possible values are: IPV4_ONLY,IPV4_IPV6, IPV6_ONLY. If not specified,IPV4_ONLY is used if the gateway IP version isIPV4, or IPV4_IPV6 if the gateway IP version isIPV6.",
"enum": [
"IPV4_IPV6",
"IPV4_ONLY",
"IPV6_ONLY"
],
"enumDescriptions": [
"Enable VPN gateway with both IPv4 and IPv6 protocols.",
"Enable VPN gateway with only IPv4 protocol.",
"Enable VPN gateway with only IPv6 protocol."
],
"type": "string"
},
"vpnInterfaces": {
"description": "The list of VPN interfaces associated with 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. [Output Only] Type of resource. Always compute#vpnGateway for\nVPN gateways.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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. [Output Only] Type of resource. Always compute#vpnGateway for\nVPN gateways.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VpnGatewayParams": {
"id": "VpnGatewayParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"VpnGatewayStatus": {
"id": "VpnGatewayStatus",
"properties": {
"vpnConnections": {
"description": "Output only. List of VPN connection for this VpnGateway.",
"items": {
"$ref": "VpnGatewayStatusVpnConnection"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"VpnGatewayStatusHighAvailabilityRequirementState": {
"description": "Describes the high availability requirement state for the VPN connection\nbetween this Cloud VPN gateway and a peer gateway.",
"id": "VpnGatewayStatusHighAvailabilityRequirementState",
"properties": {
"state": {
"description": "Indicates the high availability requirement state for the VPN connection.\nValid values are CONNECTION_REDUNDANCY_MET,CONNECTION_REDUNDANCY_NOT_MET.",
"enum": [
"CONNECTION_REDUNDANCY_MET",
"CONNECTION_REDUNDANCY_NOT_MET"
],
"enumDescriptions": [
"VPN tunnels are configured with adequate redundancy from Cloud VPN\ngateway to the peer VPN gateway. For both GCP-to-non-GCP and GCP-to-GCP\nconnections, the adequate redundancy is a pre-requirement for users to\nget 99.99% availability on GCP side; please note that for any\nconnection, end-to-end 99.99% availability is subject to proper\nconfiguration on the peer VPN gateway.",
"VPN tunnels are not configured with adequate redundancy from the Cloud\nVPN gateway to the peer gateway"
],
"type": "string"
},
"unsatisfiedReason": {
"description": "Indicates the reason why the VPN connection does not meet the high\navailability redundancy criteria/requirement.\nValid 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": "Output only. The VPN gateway interface this VPN tunnel is associated with.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"peerGatewayInterface": {
"description": "Output only. The peer gateway interface this VPN tunnel is connected to, the peer\ngateway could either be an external VPN gateway or a Google Cloud\nVPN gateway.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"tunnelUrl": {
"description": "Output only. URL reference to the VPN tunnel.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"VpnGatewayStatusVpnConnection": {
"description": "A VPN connection contains all VPN tunnels connected from this VpnGateway\nto the same peer gateway. The peer gateway could either be an external VPN\ngateway or a Google Cloud VPN gateway.",
"id": "VpnGatewayStatusVpnConnection",
"properties": {
"peerExternalGateway": {
"description": "Output only. URL reference to the peer external VPN gateways to which the VPN tunnels\nin this VPN connection are connected.\nThis field is mutually exclusive with peer_gcp_gateway.",
"readOnly": true,
"type": "string"
},
"peerGcpGateway": {
"description": "Output only. URL reference to the peer side VPN gateways to which the VPN tunnels in\nthis VPN connection are connected.\nThis field is mutually exclusive with peer_gcp_gateway.",
"readOnly": true,
"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": "Output only. [Output Only] Numeric identifier for this VPN interface associated with\nthe VPN gateway.",
"format": "uint32",
"readOnly": true,
"type": "integer"
},
"interconnectAttachment": {
"description": "URL of the VLAN attachment (interconnectAttachment) resource for this\nVPN gateway interface. When the value of this field is present, the VPN\ngateway is used for HA VPN over Cloud Interconnect; all egress\nor ingress traffic for this VPN gateway interface goes through the\nspecified VLAN attachment resource.",
"type": "string"
},
"ipAddress": {
"description": "Output only. [Output Only] IP address for this VPN interface associated with the VPN\ngateway.\nThe IP address could be either a regional external IP address or\na regional internal IP address. The two IP addresses for a VPN gateway\nmust be all regional external or regional internal IP addresses. There\ncannot be a mix of regional external IP addresses and regional internal\nIP addresses. For HA VPN over Cloud Interconnect, the IP addresses\nfor both interfaces could either be regional internal IP addresses or\nregional external IP addresses. For regular (non HA VPN over Cloud\nInterconnect) HA VPN tunnels, the IP address must be a regional external\nIP address.",
"readOnly": true,
"type": "string"
},
"ipv6Address": {
"description": "Output only. [Output Only] IPv6 address for this VPN interface associated with the VPN\ngateway.\nThe IPv6 address must be a regional external IPv6 address. The format is\nRFC 5952 format (e.g. 2001:db8::2d9:51:0:0).",
"readOnly": true,
"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\nwhen the list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nthe Cloud VPN Overview.",
"id": "VpnTunnel",
"properties": {
"cipherSuite": {
"$ref": "VpnTunnelCipherSuite",
"description": "User specified list of ciphers to use for the phase 1 and phase 2 of the\nIKE protocol."
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of this resource. Provide this property when you\ncreate 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"ikeVersion": {
"description": "IKE protocol version to use when establishing the VPN tunnel with the peer\nVPN gateway. Acceptable IKE versions are 1 or 2.\nThe default version is 2.",
"format": "int32",
"type": "integer"
},
"kind": {
"default": "compute#vpnTunnel",
"description": "Output only. [Output Only] Type of resource. Always compute#vpnTunnel for\nVPN tunnels.",
"readOnly": true,
"type": "string"
},
"labelFingerprint": {
"description": "A fingerprint for the labels being applied to this VpnTunnel, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a VpnTunnel.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035.\nLabel values may be empty.",
"type": "object"
},
"localTrafficSelector": {
"description": "Local traffic selector to use when establishing the VPN tunnel with the\npeer VPN gateway. The value should be a CIDR formatted string, for\nexample: 192.168.0.0/16. The ranges must be disjoint.\nOnly IPv4 is supported for Classic VPN tunnels. This field is output only\nfor HA VPN tunnels.",
"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.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"params": {
"$ref": "VpnTunnelParams",
"description": "Input only. [Input Only] Additional params passed with the request, but not persisted\nas part of resource payload."
},
"peerExternalGateway": {
"description": "URL of the peer side external VPN gateway to which this VPN tunnel is\nconnected.\nProvided by the client when the VPN tunnel is created.\nThis 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\nconnected. Provided by the client when the VPN tunnel is created.\nPossible values are: `0`, `1`, `2`, `3`. The number of IDs in use\ndepends on the external VPN gateway redundancy type.",
"format": "int32",
"type": "integer"
},
"peerGcpGateway": {
"description": "URL of the peer side HA VPN gateway to which this VPN tunnel\nis connected. Provided by the client when the VPN tunnel is created.\nThis field can be used when creating highly available VPN from VPC network\nto VPC network, the field is exclusive with the field peerExternalGateway.\nIf provided, the VPN tunnel will automatically use the same\nvpnGatewayInterface ID in the peer Google Cloud VPN gateway.",
"type": "string"
},
"peerIp": {
"description": "IP address of the peer VPN gateway. Only IPv4 is supported. This field can\nbe set only for Classic VPN tunnels.",
"type": "string"
},
"region": {
"description": "[Output Only] URL of the region where the VPN tunnel resides.\nYou must specify this field as part of the HTTP request URL. It is\nnot settable as a field in the request body.",
"type": "string"
},
"remoteTrafficSelector": {
"description": "Remote traffic selectors to use when establishing the VPN tunnel with\nthe peer VPN gateway. The value should be a CIDR formatted string,\nfor example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is\nsupported for Classic VPN tunnels. This field is output only for HA VPN\ntunnels.",
"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\nand 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\nfollowing:\n   \n   - PROVISIONING: Resource is being allocated for the VPN tunnel.\n   - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs\n   from\n     the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route\n     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\n   VPN. \n   - NETWORK_ERROR: Deprecated, replaced by\n   NO_INCOMING_PACKETS \n   - AUTHORIZATION_ERROR: Auth error (for example,\n   bad shared secret). \n   - NEGOTIATION_FAILURE: Handshake failed.\n   - DEPROVISIONING: Resources are being deallocated for the VPN\n   tunnel. \n   - FAILED: Tunnel creation has failed and the tunnel is not\n   ready to be used. \n   - NO_INCOMING_PACKETS: No incoming packets from\n   peer. \n   - REJECTED: Tunnel configuration was rejected, can be result\n   of being denied access. \n   - ALLOCATING_RESOURCES: Cloud VPN is in the\n   process of allocating all required resources.\n   - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted\n   for Classic VPN tunnels or the project is in frozen state.\n   - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP,\n   probably behind NAT. \n   - TS_NARROWING_NOT_ALLOWED: Traffic selector\n   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": [
"Cloud VPN is in the process of allocating all required resources\n(specifically, a borg task).",
"Auth error (e.g. bad shared secret).",
"Resources is being deallocated for the VPN tunnel.",
"Secure session is successfully established with peer VPN.",
"Tunnel creation has failed and the tunnel is not ready to be used.",
"Successful first handshake with peer VPN.",
"Handshake failed.",
"Deprecated, replaced by NO_INCOMING_PACKETS",
"No incoming packets from peer",
"Resource is being allocated for the VPN tunnel.",
"Tunnel configuration was rejected, can be result of being denylisted.",
"Tunnel is stopped due to its Forwarding Rules being deleted.",
"Waiting to receive all VPN-related configs from user. Network,\nTargetVpnGateway, VpnTunnel, ForwardingRule and Route resources are\nneeded to setup VPN tunnel."
],
"type": "string"
},
"targetVpnGateway": {
"description": "URL of the Target VPN gateway with which this VPN tunnel is associated.\nProvided by the client when the VPN tunnel is created.\nThis field can be set only for Classic VPN tunnels.",
"type": "string"
},
"vpnGateway": {
"description": "URL of the VPN gateway with which this VPN tunnel is associated.\nProvided by the client when the VPN tunnel is created. This must be\nused (instead of target_vpn_gateway) if a High Availability VPN gateway\nresource is created.",
"type": "string"
},
"vpnGatewayInterface": {
"description": "The interface ID of the VPN gateway with which this VPN tunnel is\nassociated.\nPossible values are: `0`, `1`.",
"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. [Output Only] Type of resource. Always compute#vpnTunnel for\nVPN tunnels.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VpnTunnelCipherSuite": {
"id": "VpnTunnelCipherSuite",
"properties": {
"phase1": {
"$ref": "VpnTunnelPhase1Algorithms"
},
"phase2": {
"$ref": "VpnTunnelPhase2Algorithms"
}
},
"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. [Output Only] Type of resource. Always compute#vpnTunnel for\nVPN tunnels.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"VpnTunnelParams": {
"id": "VpnTunnelParams",
"properties": {
"resourceManagerTags": {
"additionalProperties": {
"type": "string"
},
"description": "Tag keys/values directly bound to this resource.\nTag keys and values have the same definition as resource\nmanager tags. The field is allowed for INSERT\nonly. The keys/values to set on the resource should be specified in\neither ID { : } or Namespaced format\n{ : }.\nFor example the following are valid inputs:\n* {\"tagKeys/333\" : \"tagValues/444\", \"tagKeys/123\" : \"tagValues/456\"}\n* {\"123/environment\" : \"production\", \"345/abc\" : \"xyz\"}\nNote:\n* Invalid combinations of ID & namespaced format is not supported. For\n  instance: {\"123/environment\" : \"tagValues/444\"} is invalid.\n* Inconsistent format is not supported. For instance:\n  {\"tagKeys/333\" : \"tagValues/444\", \"123/env\" : \"prod\"} is invalid.",
"type": "object"
}
},
"type": "object"
},
"VpnTunnelPhase1Algorithms": {
"id": "VpnTunnelPhase1Algorithms",
"properties": {
"dh": {
"items": {
"type": "string"
},
"type": "array"
},
"encryption": {
"items": {
"type": "string"
},
"type": "array"
},
"integrity": {
"items": {
"type": "string"
},
"type": "array"
},
"prf": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"VpnTunnelPhase2Algorithms": {
"id": "VpnTunnelPhase2Algorithms",
"properties": {
"encryption": {
"items": {
"type": "string"
},
"type": "array"
},
"integrity": {
"items": {
"type": "string"
},
"type": "array"
},
"pfs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"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\nthe list is empty.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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:\n- E.g. XSS-stable\nGeneric suffix like \"stable\" is particularly useful if a policy\nlikes to avail newer set of expressions without having to change\nthe policy.\nA 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:\n- E.g. XSS-20170329\nrequired",
"type": "string"
}
},
"type": "object"
},
"WafExpressionSetExpression": {
"id": "WafExpressionSetExpression",
"properties": {
"id": {
"description": "Expression ID should uniquely identify the origin of the expression.\nE.g. owasp-crs-v020901-id973337 identifies Owasp core rule set\nversion 2.9.1 rule id 973337.\nThe ID could be used to determine the individual attack definition\nthat has been detected. It could also be used to exclude it from\nthe policy in case of false positive.\nrequired",
"type": "string"
},
"sensitivity": {
"description": "The sensitivity value associated with the WAF rule ID. This corresponds\nto the ModSecurity paranoia level, ranging from 1 to 4. 0 is reserved for\nopt-in only rules.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"WeightedBackendService": {
"description": "In contrast to a single BackendService in \nHttpRouteAction to which all matching traffic is directed to,WeightedBackendService allows traffic to be split across\nmultiple backend services. The volume of traffic for each\nbackend service is proportional to the weight specified\nin each WeightedBackendService",
"id": "WeightedBackendService",
"properties": {
"backendService": {
"description": "The full or partial URL to the default BackendService\nresource. Before\nforwarding the request to backendService, the load balancer\napplies any relevant headerActions specified as part of thisbackendServiceWeight.",
"type": "string"
},
"headerAction": {
"$ref": "HttpHeaderAction",
"description": "Specifies changes to request and response headers that need to take\neffect for the selected backendService.\n\nheaderAction specified here take effect beforeheaderAction in the enclosing HttpRouteRule,PathMatcher and UrlMap.\n\nheaderAction is not supported for load balancers that have\ntheir loadBalancingScheme set to EXTERNAL.\n\nNot supported when the URL map is bound to a target gRPC proxy that\nhas validateForProxyless field set to true."
},
"weight": {
"description": "Specifies the fraction of traffic sent to a backend service,\ncomputed asweight / (sum of all weightedBackendService weights in routeAction).\n\nThe selection of a backend service is determined only for new traffic.\nOnce a user's request has been directed to a backend service,\nsubsequent requests are sent to the same backend service as\ndetermined by the backend service's session affinity policy.\nDon't configure session affinity if you're using weighted traffic\nsplitting. If you do, the weighted traffic splitting configuration takes\nprecedence.\n\nThe value must be from 0 to 1000.",
"format": "uint32",
"type": "integer"
}
},
"type": "object"
},
"Wire": {
"description": "A pseudowire that connects two Interconnect connections.",
"id": "Wire",
"properties": {
"adminEnabled": {
"description": "Output only. [Output Only] Indicates whether the wire is enabled.\nWhen false, the wire is disabled. When true and when the wire group of\nthe wire is also enabled, the wire is enabled. Defaults to true.",
"readOnly": true,
"type": "boolean"
},
"endpoints": {
"description": "Output only. Wire endpoints are specific Interconnect connections.",
"items": {
"$ref": "WireEndpoint"
},
"readOnly": true,
"type": "array"
},
"label": {
"description": "Output only. [Output Only] A label that identifies the wire. The format of this label\ncombines the existing labels of the wire group endpoints and Interconnect\nconnections used by this wire in alphabetical order as follows:\n`ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1`, where:\n   \n   - ENDPOINT_A and ENDPOINT_B: are the labels\n   that you entered as map keys when you specified the wire group endpoint\n   objects.\n   - CONNECTION_A1 and CONNECTION_B1: are the\n   labels that you entered as map keys when you specified the wire group\n   Interconnect objects.",
"readOnly": true,
"type": "string"
},
"wireProperties": {
"$ref": "WireProperties",
"description": "Output only. [Output Only] Properties of the wire.",
"readOnly": true
}
},
"type": "object"
},
"WireEndpoint": {
"description": "Wire endpoints are specific Interconnect connections.",
"id": "WireEndpoint",
"properties": {
"interconnect": {
"readOnly": true,
"type": "string"
},
"vlanTag": {
"format": "int32",
"readOnly": true,
"type": "integer"
}
},
"type": "object"
},
"WireGroup": {
"description": "A resource that represents a group of redundant wires.",
"id": "WireGroup",
"properties": {
"adminEnabled": {
"description": "Indicates whether the wires in the wire group are enabled. When false, the\nwires in the wire group are disabled. When true and when\nthere is simultaneously no wire-specific override of `adminEnabled` to\nfalse, a given wire is enabled. Defaults to true.",
"type": "boolean"
},
"creationTimestamp": {
"description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "An optional description of the wire group.",
"type": "string"
},
"endpoints": {
"additionalProperties": {
"$ref": "WireGroupEndpoint"
},
"description": "A map that contains the logical endpoints of the wire group. Specify\nkey-value pairs for the map as follows:\n   \n   - Key: an RFC1035 user-specified label.\n   - Value: an Endpoint object.",
"type": "object"
},
"id": {
"description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
"format": "uint64",
"readOnly": true,
"type": "string"
},
"kind": {
"default": "compute#wireGroup",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"type": "string"
},
"reconciling": {
"description": "Output only. [Output Only] Indicates whether there are wire changes yet to be processed.",
"readOnly": true,
"type": "boolean"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for the resource.",
"readOnly": true,
"type": "string"
},
"topology": {
"$ref": "WireGroupTopology",
"description": "Output only. Topology details for the wire group configuration.",
"readOnly": true
},
"wireProperties": {
"$ref": "WireProperties",
"description": "Properties for all wires in the wire group."
},
"wires": {
"description": "Output only. The single/redundant wire(s) managed by the wire group.",
"items": {
"$ref": "Wire"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"WireGroupEndpoint": {
"description": "A logical endpoint for the wire group. An endpoint represents a metro that\ncontains redundant Interconnect connections. A wire group is created\nbetween two endpoints.",
"id": "WireGroupEndpoint",
"properties": {
"interconnects": {
"additionalProperties": {
"$ref": "WireGroupEndpointInterconnect"
},
"description": "A map that contains the redundant Interconnect connections. Specify\nkey-value pairs for the map as follows:\n   \n   - Key: an RFC1035 user-specified label.\n   - Value: an Interconnect object.",
"type": "object"
}
},
"type": "object"
},
"WireGroupEndpointInterconnect": {
"description": "The redundant Interconnect connections for this endpoint.",
"id": "WireGroupEndpointInterconnect",
"properties": {
"interconnect": {
"description": "Required. An Interconnect connection. You can specify the connection as\na partial or full URL. If the connection is in a different project from\nthe cross-site network, use a format that specifies the project. See\nthe following examples of partial and full URLs:\n   \n   \n    \n      global/interconnects/NAME\n    \n    \n       projects/PROJECT_ID/global/interconnects/NAME\n    \n    - \n      https://compute.googleapis.com/compute/projects/PROJECT_ID/global/interconnects/NAME",
"type": "string"
},
"vlanTags": {
"description": "Required. To configure the wire group for VLAN mode, enter a VLAN tag,\nwhich is a number from `2` to `4093`. You can autoallocate a tag by\nentering `0`. To configure the wire group for port mode, enter `-1`.\nReview the following guidelines:\n   \n   - A VLAN tag must be unique for an Interconnect connection across all\n   attachments and wire groups.\n   - Both endpoints of a wire must use the same VLAN tag value.\n   - Single wire and redundant type wire groups must have only one\n   VLAN tag.\n   - Port mode pseudowires must have a single VLAN tag with a value of\n   `-1` for both endpoints.\n   - Box and cross type wire groups must have two VLAN tags. The first\n   is for the same-zone pseudowire, and the second is for the cross-zone\n   pseudowire.",
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
},
"type": "object"
},
"WireGroupList": {
"description": "Response for the list request.",
"id": "WireGroupList",
"properties": {
"etag": {
"type": "string"
},
"id": {
"description": "[Output Only] Unique identifier for the resource; defined by the server.",
"type": "string"
},
"items": {
"description": "A list of wire group resources.",
"items": {
"$ref": "WireGroup"
},
"type": "array"
},
"kind": {
"default": "compute#wireGroup",
"description": "Output only. [Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "[Output Only] Server-defined URL for this resource.",
"type": "string"
},
"unreachables": {
"description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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"
},
"WireGroupTopology": {
"description": "Topology details for the wire group.",
"id": "WireGroupTopology",
"properties": {
"endpoints": {
"description": "Output only. Topology details for all endpoints in the wire group.",
"items": {
"$ref": "WireGroupTopologyEndpoint"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"WireGroupTopologyEndpoint": {
"description": "Topology details for a single wire group endpoint.",
"id": "WireGroupTopologyEndpoint",
"properties": {
"city": {
"description": "Output only. The InterconnectLocation.city (metropolitan area designator) that all\ninterconnects are located in.",
"readOnly": true,
"type": "string"
},
"label": {
"description": "Output only. Endpoint label from the wire group.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"WireProperties": {
"description": "The properties of a wire.",
"id": "WireProperties",
"properties": {
"bandwidthAllocation": {
"description": "The configuration of the bandwidth allocation, one of the following:\n   \n   - ALLOCATE_PER_WIRE: configures a separate unmetered bandwidth allocation\n   (and associated charges) for each wire in the group.\n   - SHARED_WITH_WIRE_GROUP: this is the default behavior, which configures\n   one unmetered bandwidth allocation for the wire group. The unmetered\n   bandwidth is divided equally across each wire in the group, but dynamic\n   throttling reallocates unused unmetered bandwidth from unused or underused\n   wires to other wires in the group.",
"enum": [
"ALLOCATE_PER_WIRE",
"SHARED_WITH_WIRE_GROUP"
],
"enumDescriptions": [
"Configures a separate unmetered bandwidth allocation (and associated\ncharges) for each wire in the group.",
"This is the default behavior. Configures one unmetered bandwidth\nallocation for the wire group. The unmetered bandwidth is divided equally\nacross each wire in the group, but dynamic throttling reallocates unused\nunmetered bandwidth from unused or underused wires to other wires in the\ngroup."
],
"type": "string"
},
"bandwidthUnmetered": {
"description": "The unmetered bandwidth in Gigabits per second, using decimal units. `10`\nis 10 Gbps, `100` is 100 Gbps. The bandwidth must be greater than 0.",
"format": "int64",
"type": "string"
},
"faultResponse": {
"description": "Response when a fault is detected in a pseudowire:\n   \n   - NONE: default.\n   - DISABLE_PORT: set the port line protocol down when inline probes\n   detect a fault. This setting is only permitted on port mode\n   pseudowires.",
"enum": [
"DISABLE_PORT",
"NONE"
],
"enumDescriptions": [
"Set the port line protocol down when inline probes detect a fault. This\nsetting is only permitted on port mode pseudowires.",
"Default."
],
"type": "string"
}
},
"type": "object"
},
"WorkloadIdentityConfig": {
"id": "WorkloadIdentityConfig",
"properties": {
"identity": {
"type": "string"
},
"identityCertificateEnabled": {
"type": "boolean"
}
},
"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. [Output Only] Type of resource. Always compute#xpnHostList for\nlists of shared VPC hosts.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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\nsupports project id (e.g., my-project-123) and project number\n(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.\nFor example the zone us-east1-b is located in theus-east1 region. For more information, readRegions and\nZones.",
"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 inRFC3339\ntext 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\ndefined by the server.",
"format": "uint64",
"type": "string"
},
"kind": {
"default": "compute#zone",
"description": "Output only. [Output Only] Type of the resource. Always compute#zone for\nzones.",
"readOnly": true,
"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 orDOWN.",
"enum": [
"DOWN",
"UP"
],
"enumDescriptions": [
"",
""
],
"type": "string"
},
"supportsPzs": {
"description": "Output only. [Output Only] Reserved for future use.",
"readOnly": true,
"type": "boolean"
}
},
"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": "Output only. Type of resource.",
"readOnly": true,
"type": "string"
},
"nextPageToken": {
"description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
"type": "string"
},
"selfLink": {
"description": "Output only. [Output Only] Server-defined URL for this resource.",
"readOnly": true,
"type": "string"
},
"warning": {
"description": "[Output Only] Informational warning message.",
"properties": {
"code": {
"description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare 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",
"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
"LARGE_DEPLOYMENT_WARNING",
"LIST_OVERHEAD_QUOTA_EXCEED",
"MISSING_TYPE_DEPENDENCY",
"NEXT_HOP_ADDRESS_NOT_ASSIGNED",
"NEXT_HOP_CANNOT_IP_FORWARD",
"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
"NEXT_HOP_INSTANCE_NOT_FOUND",
"NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
"NEXT_HOP_NOT_RUNNING",
"NOT_CRITICAL_ERROR",
"NO_RESULTS_ON_PAGE",
"PARTIAL_SUCCESS",
"QUOTA_INFO_UNAVAILABLE",
"REQUIRED_TOS_AGREEMENT",
"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
"RESOURCE_NOT_DELETED",
"SCHEMA_VALIDATION_IGNORED",
"SINGLE_INSTANCE_PROPERTY_TEMPLATE",
"UNDECLARED_PROPERTIES",
"UNREACHABLE"
],
"enumDeprecated": [
false,
false,
false,
false,
false,
false,
true,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false,
false
],
"enumDescriptions": [
"Warning about failed cleanup of transient changes made by a failed\noperation.",
"A link to a deprecated resource was created.",
"When deploying and at least one of the resources has a type marked as\ndeprecated",
"The user created a boot disk that is larger than image size.",
"When deploying and at least one of the resources has a type marked as\nexperimental",
"Warning that is present in an external api call",
"Warning that value of a field has been overridden.\nDeprecated unused field.",
"The operation involved use of an injected kernel, which is deprecated.",
"A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
"When deploying a deployment with a exceedingly large number of resources",
"Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
"A resource depends on a missing type",
"The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
"The route's next hop instance cannot ip forward.",
"The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
"The route's nextHopInstance URL refers to an instance that does not exist.",
"The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
"The route's next hop instance does not have a status of RUNNING.",
"Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
"No results are present on a particular list page.",
"Success is reported, but some results may be missing due to errors",
"Quota information is not available to client requests (e.g:\nregions.list).",
"The user attempted to use a resource that requires a TOS they have not\naccepted.",
"Warning that a resource is in use.",
"One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
"When a resource schema validation is ignored.",
"Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
"When undeclared properties in the schema are present",
"A given scope cannot be reached."
],
"type": "string"
},
"data": {
"description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n  {\n   \"key\": \"scope\",\n   \"value\": \"zones/us-east1-d\"\n  }",
"items": {
"properties": {
"key": {
"description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts 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,\nused to detect conflicts. The fingerprint is initially generated by Compute\nEngine and changes after every request to modify or update labels. You must\nalways provide an up-to-date fingerprint hash in order to update or change\nlabels. Make a get() request to the resource to get the latest\nfingerprint.",
"format": "byte",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "The labels to set for this resource.",
"type": "object"
}
},
"type": "object"
},
"ZoneSetNestedPolicyRequest": {
"id": "ZoneSetNestedPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. 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\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
},
"ZoneSetPolicyRequest": {
"id": "ZoneSetPolicyRequest",
"properties": {
"bindings": {
"description": "Flatten Policy to create a backwacd compatible wire-format.\nDeprecated. Use 'policy' to specify bindings.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "Flatten Policy to create a backward compatible wire-format.\nDeprecated. 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\nthe policy is limited to a few 10s of KB. An empty policy is in general a\nvalid policy but certain services (like Projects) might reject them."
}
},
"type": "object"
}
},
"servicePath": "compute/v1/",
"serviceVersion": "v1",
"title": "Compute Engine API",
"version": "v1"
}